Version: 2020.2
LanguageEnglish
  • C#

ContactFilter2D.IsFilteringNormalAngle

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

public bool IsFilteringNormalAngle(Vector2 normal);

Parameters

normal The normal used to calculate an angle.

Returns

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

Description

Checks if the angle of normal is within the normal angle range to be filtered.

Filtering is defined as including or excluding objects based upon a specific condition. Normal angle filtering checks an angle and includes it when it is within the normal angle range and excludes it if otherwise. IsFilteringNormalAngle returns true when useNormalAngle is set to true and the angle is outside the normal angle range defined by minNormalAngle and maxNormalAngle. This indicates the angle is filtered which means it should be excluded. IsFilteringNormalAngle returns false if otherwise. Note:: Setting useOutsideNormalAngle to true inverts the function behavior and it returns opposite results. See Also: useNormalAngle, ::ref:minNormalAngle & maxNormalAngle.


public bool IsFilteringNormalAngle(float angle);

Parameters

angle The angle used for comparison in the filter.

Returns

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

Description

Checks if the angle is within the normal angle range to be filtered.

Filtering is defined as including or excluding objects based upon a specific condition. Normal angle filtering checks an angle and includes it when it is within the normal angle range and excludes it if otherwise. IsFilteringNormalAngle returns true when useNormalAngle is set to true and the angle is outside the normal angle range defined by minNormalAngle and maxNormalAngle. This indicates the angle is filtered which means it should be excluded. IsFilteringNormalAngle returns false if otherwise. Note:: Setting useOutsideNormalAngle to true inverts the function behavior and it returns opposite results. See Also: useNormalAngle, ::ref:minNormalAngle & maxNormalAngle.