Version: 2023.1
LanguageEnglish
  • C#

ContactFilter2D.IsFilteringDepth

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public bool IsFilteringDepth(GameObject obj);

Parameters

obj The GameObject used to check the z-position (depth) of Transform.position.

Returns

bool Returns true when obj is excluded by the filter and false if otherwise.

Description

Checks if the Transform for obj is within the depth range to be filtered.

Filtering is defined as including or excluding objects based upon a specific condition. Depth filtering checks the z-position of a GameObject Transform.position and includes it when it is within the depth range and excludes it if otherwise. IsFilteringDepth returns true when useDepth is set to true and the obj transform's z-position is outside the depth defined by minDepth and maxDepth. This indicates the obj is filtered which means it should be excluded. IsFilteringDepth returns false if otherwise. Note:: Setting useOutsideDepth to true inverts the function behavior and it returns opposite results. See Also: useDepth, ::ref:minDepth & maxDepth.

Copyright © 2023 Unity Technologies
优美缔软件(上海)有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961