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.
CloseFor 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.
Closeobj | The GameObject used to check the z-position (depth) of Transform.position. |
bool
Returns true when obj
is excluded by the filter and false if otherwise.
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.
Additional resources: useDepth, ::ref:minDepth & maxDepth.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.