RAIN.Sensors.NavigationGeometryCollider Class Reference

NavigationGeometryCollider is used to pick up general physics collider information that is relevant to navigation, either for obstacle avoidance or for real-time recast. More...

List of all members.

Public Member Functions

void Start ()
 Start() is the Unity event handler for initialization and setup.
void Resize (float distance)
 Resize changes the radius of the sphere collider.
void OnTriggerEnter (Collider sensedObject)
 Collider OnTriggerEnter handler.
void OnTriggerStay (Collider sensedObject)
 Collider OnTriggerStay handler.
void OnTriggerExit (Collider sensedObject)
 Collider OnTriggerExit handler.
List< Bounds > GetBoundsList ()
 Retrive a list of collider bounds from all colliders that are currently colliding with the sensor.
List< Collider > GetColliderList ()
 GetColliderList returns a list of all Colliders currently colliding with the sensor.
void MarkClean ()
 Reset the "dirty" flag. Future calls to IsDirty will only return true if a collider enters or leaves the sensor collider.

Properties

bool IsDirty [get]
 Determine if any change in colliding objects has occurred since the last MarkClean call.

Detailed Description

NavigationGeometryCollider is used to pick up general physics collider information that is relevant to navigation, either for obstacle avoidance or for real-time recast.


Member Function Documentation

List<Bounds> RAIN.Sensors.NavigationGeometryCollider.GetBoundsList ( )

Retrive a list of collider bounds from all colliders that are currently colliding with the sensor.

Returns:
A List of Bounds
List<Collider> RAIN.Sensors.NavigationGeometryCollider.GetColliderList ( )

GetColliderList returns a list of all Colliders currently colliding with the sensor.

Returns:
A List of Colliders
void RAIN.Sensors.NavigationGeometryCollider.MarkClean ( )

Reset the "dirty" flag. Future calls to IsDirty will only return true if a collider enters or leaves the sensor collider.

void RAIN.Sensors.NavigationGeometryCollider.OnTriggerEnter ( Collider  sensedObject)

Collider OnTriggerEnter handler.

Parameters:
sensedObject
void RAIN.Sensors.NavigationGeometryCollider.OnTriggerExit ( Collider  sensedObject)

Collider OnTriggerExit handler.

Parameters:
sensedObject
void RAIN.Sensors.NavigationGeometryCollider.OnTriggerStay ( Collider  sensedObject)

Collider OnTriggerStay handler.

Parameters:
sensedObject
void RAIN.Sensors.NavigationGeometryCollider.Resize ( float  distance)

Resize changes the radius of the sphere collider.

Parameters:
distance
void RAIN.Sensors.NavigationGeometryCollider.Start ( )

Start() is the Unity event handler for initialization and setup.


Property Documentation

bool RAIN.Sensors.NavigationGeometryCollider.IsDirty [get]

Determine if any change in colliding objects has occurred since the last MarkClean call.

Returns:
true if a change has occured in colliding objects, false otherwise