Ray objects allow you to cast a collision ray through the scene; you can choose to cast a collision ray against the Scene geometries (and other objects bounds), against the physic World collision bounds or against the navigation Map.

Since rays are basically objects they can be manipulated and parented the same way as any other type of Object.

Using them you can get direct collision feedback allowing you to easily create logic based on a hit or a miss. Rays can be used to create (ie) a laser sight, triggers; attached to bones they can be used to control a locomotion system activating constraints and inverse kinematics and more...

See Also

Object, Scene, World, Map, Geometry

Static Variables

Name	Description
`object`	Parent Object that maintain the active Ray reference.
Declaration Object *object
`config`	Reference to the RayConfig available for the active RayType used by the Ray.
Declaration RayConfig *config
`result`	Reference to the RayResult result based on the RayType used by the active Ray.
Declaration RayResult *result

Variables

Name	Description
`fps`	Update rate of the active Ray in Mhz.
Declaration unsigned char fps Range 0 to 120 Mhz Note A value of `0` fps force the system to launch a new raycast request every frame.
`length`	Maximum distance the Ray can hit.
Declaration float length Range 0.01 to inf.
`enabled`	Control wheter or not the Ray should continuously launch raycast requests.
Declaration bool enabled
`ray_type`	Current RayType used by the Ray Object.
Declaration RayType ray_type
`sync_time`	Last time the Ray was re-evaluated.
Declaration float sync_time

Events

The event listed below is available to any Script connected to an Object of the type Ray.

Callbacks Description

OnHit Triggered when the ray intersect with something and a contact point is available.

Declaration

function OnHit()

RayConfig

Based on the active RayType this structure allow you to access the base parameters that will be used during the raycast operation.

Static Variables

Name	Description
`scene`	Access the settings of a `kSceneRay` RayType Ray.
Declaration SceneRayConfig *scene Note This variable will be set to `nil` of the current RayType is not `kSceneRay`.
`world`	Access the settings of a `kWorldRay` RayType Ray.
Declaration WorldRayConfig *world Note This variable will be set to `nil` of the current RayType is not `kWorldRay`.
`map`	Access the settings of a `kMapRay` RayType Ray.
Declaration MapRayConfig *map Note This variable will be set to `nil` of the current RayType is not `kMapRay`.

SceneRayConfig

Available configuration variables when the Ray type is set to kSceneRay.

Variables

Name Description

precision The Precision qualifier to use to execute the raycast operation.

Declaration

Precision precision

Qualifier	Description
`kLow`	Raycast the bounding sphere of each Object to find a suitable hit.
`kMedium`	Raycast the axis aligned bounding box of each Object to find a suitable hit.
`kHigh`	Raycast the Scene Geometry of each Object (when available); if no Geometry is available, the system will use the world aligned bounding box of the Object to find a suitable hit.

cull_face Control wheter back faces should be culled or not.

Declaration

bool cull_face

inclusion_mask Bit mask of ObjectType which represent each class that should be included during the raycast operation.

Declaration

int inclusion_mask

filter An optional substring that needs to be present within the Object name in order for it to be part of the raycast operation.

Declaration

char *filter

WorldRayConfig

Available configuration variables when the Ray type is set to kWorldRay.

Variables

Name	Description
`cull_face`	Control wheter back faces should be culled or not.
Declaration bool cull_face
`single`	Determine if the raycast operation should stop at the first hit or continue (multi-hit).
Declaration bool single
`collisionlayer_mask`	Bit mask of CollisionLayer cap that define the placement of the Ray.
Declaration int collisionlayer_mask
`collisionlayer_filter`	Bit mask of CollisionLayer cap that defines with which layer the Ray can collide.
Declaration int collisionlayer_filter

MapRayConfig

Available configuration variables when the Ray type is set to kMapRay.

Variables

Name	Description
`cull_face`	Control wheter back faces should be culled or not.
Declaration bool cull_face
`navigation_map`	Unique id of an existing Navigation Map to effectuate the raycast.
Declaration unsigned int navigation_map

RayResult

Based on the RayType of the active Ray access the result of the raycast operation.

Static Variables

Name	Description
`scene`	Reference to a SceneRay that contains the result of `kSceneRay` raycast operation.
Declaration SceneRay *scene Note This variable will be set to `nil` of the active RayType is not `kSceneRay`.
`world`	Reference to a WorldRay that contains the result of `kWorldRay` raycast operation.
Declaration WorldRay *world Note This variable will be set to `nil` of the active RayType is not `kWorldRay`.
`map`	Reference to a MapRay that contains the result of `kMapRay` raycast operation.
Declaration MapRay *map Note This variable will be set to `nil` of the active RayType is not `kMapRay`.

RayType

Available types of raycast operations that can be used by a Ray Object.

kSceneRay: Raycast all Geometry in the Scene.
kWorldRay: Raycast the physic World.
kMapRay: Raycast an existing navigation Map.