IsFilteringNormalAngle
Checks if the angle of normal is within the normal angle range to be filtered.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.Physics2DModule
IsFilteringNormalAngle(Vector2)
Checks if the angle of is within the normal angle range to be filtered.
normalpublic bool IsFilteringNormalAngle(Vector2 normal)
Parameters
The normal used to calculate an angle.
Returns
Type | Description |
|---|---|
| bool | Returns true when |
Remarks
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 ContactFilter2D.useNormalAngle is set to true and the angle is outside the normal angle range defined by ContactFilter2D.minNormalAngle and ContactFilter2D.maxNormalAngle. This indicates the angle is filtered which means it should be excluded. IsFilteringNormalAngle returns false if otherwise. Note:: Setting ContactFilter2D.useOutsideNormalAngle to true inverts the function behavior and it returns opposite results. Additional Resources: ContactFilter2D.useNormalAngle, ::ref:minNormalAngle & ContactFilter2D.maxNormalAngle.
IsFilteringNormalAngle(float)
Checks if the is within the normal angle range to be filtered.
anglepublic bool IsFilteringNormalAngle(float angle)
Parameters
The angle used for comparison in the filter.
Returns
Type | Description |
|---|---|
| bool | Returns true when |
Remarks
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 ContactFilter2D.useNormalAngle is set to true and the angle is outside the normal angle range defined by ContactFilter2D.minNormalAngle and ContactFilter2D.maxNormalAngle. This indicates the angle is filtered which means it should be excluded. IsFilteringNormalAngle returns false if otherwise. Note:: Setting ContactFilter2D.useOutsideNormalAngle to true inverts the function behavior and it returns opposite results. Additional Resources: ContactFilter2D.useNormalAngle, ::ref:minNormalAngle & ContactFilter2D.maxNormalAngle.