A scene can be considered as a level. It is where you place objects to create your worlds, but it could also be used in many different ways. A scene can be considered as an "image" or part of an "image"; it can not only be use to draw geometry on screen but can also be used to draw GUI, HUD (with a 2d camera) or to progressively load at runtime a seamless open world.

Static Variables

Name	Description
`asset`	Reference to the parent Asset where the Scene data is maintained.
Declaration Asset *asset
`localbounds`	The active Scene boundaries.
Declaration LocalBounds localbounds
`object_count`	Total amount of Object currently contained in the active Scene.
Declaration unsigned int object_count
`renderlayer_count`	Number of RenderLayer available within the current Scene.
Declaration unsigned char renderlayer_count
`subscene_count`	Amount of sub Scene that will be loaded along with the current Scene.
Declaration unsigned char subscene_count
`objectgroup_count`	Number of ObjectGroup currently defined in the active Scene.
Declaration unsigned char objectgroup_count
`soundgroup_count`	Total of SoundGroup maintained by the Scene.
Declaration unsigned char soundgroup_count
`audiopreset_count`	Number of AudioPreset available in the current Scene.
Declaration unsigned char audiopreset_count
`variable_count`	Amount of member Variable defined in the active Scene.
Declaration unsigned short variable_count
`animation`	Animation structure that handles the Action and Sequence of the active Scene.
Declaration Animation animation
`handler`	Handler reference that maintains the scripting thread of the current Scene.
Declaration Handler handler
`navigation`	Access to the Navigation structure associated to the Scene (if any).
Declaration Navigation *navigation
`loading`	Boolean value that represent if the Scene is currently loading or not.
Declaration bool loading Remarks Only available when the Scene is loaded asynchronously.

Variables

Name	Description
`renderlayer_mask`	Bit mask of RenderLayer cap that describes which layers are currently available for rendering.
Declaration int renderlayer_mask
`debug_mode`	Bit mask of the debug mode(s) to use while the Scene is in edit mode (editor only).
Declaration DebugMode debug_mode
`active`	Activate or deactive Scene updates.
Declaration bool active
`visible`	Enable or disable the active Scene rendering.
Declaration bool visible
`visible`	Enable or disable the active Scene rendering.
Declaration bool visible
`store_audioeffects`	Force to save the current AudioEffect configuration inside the active Scene.
Declaration bool store_audioeffects
`cursor_normal`	The direction vector at the 3d cursor location.
Declaration vec4 cursor_normal Remarks The `X,Y` and `Z` component defines the direction vector of the 3d cursor; the `W` component represent whether or not new Object should be aligned to the direction maintained by the vector.

Functions

Name	Description
`AddRenderLayer`	Create and append a new RenderLayer to the active Scene.
Declaration RenderLayer AddRenderLayer( const char name, int cap ) Parameters `name`: A name to identify the RenderLayer within the active Scene. `cap`: Unique cap value to represent the new RenderLayer using a bit mask; use `-1` to let the system assign a unique cap (recommended). Return Value Reference to the newly created RenderLayer.
`GetRenderLayer`	Retrieve an existing RenderLayer using its name as key.
Declaration RenderLayer GetRenderLayer( const char name ) Parameters `name`: The name of the RenderLayer to retrieve. Return Value On sucess return the reference to the RenderLayer that correspond with the name received in parameter; else return `nil`.
`GetRenderLayerAt`	Return an existing RenderLayer located at a specific index.
Declaration RenderLayer GetRenderLayerAt( unsigned char index ) Parameters* `index`: Index of the RenderLayer to retrieve. Return Value `nil` if the index provided is invalid; else return the RenderLayer reference.
`GetRenderLayerIndex`	Retrieve the index of an existing RenderLayer.
Declaration int GetRenderLayerIndex( const RenderLayer renderlayer ) Parameters* `renderlayer`: Reference to an existing RenderLayer associated with current Scene. Return Value `-1` if the RenderLayer reference received in parameter is invalid; else return its index.
`SetRenderLayerIndex`	Manually set the list index of an existing RenderLayer.
Declaration bool SetRenderLayerIndex( RenderLayer renderlayer, const unsigned char index ) Parameters* `renderlayer`: Reference of the RenderLayer to move. `index`: The new index location of the RenderLayer in the list. Return Value `true` on success, else return `false` if either the RenderLayer reference or the `index` received in parameter is invalid.
`RemoveRenderLayer`	Remove a specific RenderLayer reference from the Scene.
Declaration bool RemoveRenderLayer( RenderLayer renderlayer ) Parameters* `renderlayer`: Reference to the RenderLayer to remove. Return Value `true` is the operation succeed; `false` if the RenderLayer reference is invalid (`nil`) or if the RenderLayer is not connected to the active Scene.
`RemoveRenderLayerAt`	Remove a RenderLayer by index.
Declaration bool RemoveRenderLayerAt( int index ) Parameters `index`: Index of the RenderLayer to remove. Return Value `true` on success, else return `false` if the index is out of bounds.
`SwapRenderLayers`	Swap the location of two RenderLayer using their index as key.
Declaration bool SwapRenderLayers( unsigned char index0, unsigned char index1 ) Parameters `index0`: Index of the RenderLayer to swap. `index1`: The new index location to swap the RenderLayer to. Return Value `true` on success; `false` if either the source or the destination index is invalid.
`AddSubScene`	Add a new sub Scene slot.
Declaration int AddSubScene( void ) Return Value The index of the newly created slot.
`GetSubScene`	Retrieve the Scene Asset reference using the slot index as key.
Declaration Asset GetSubScene( const unsigned char index ) Parameters* `index`: Index of the sub Scene slot to retrieve. Return Value Reference to the Asset connected to the slot pointed by index; `nil` if the slot index is invalid or no Asset is currently connected to it.
`SetSubScene`	Assign to a specific slot the sub Scene Asset to load.
Declaration bool SetSubScene( const unsigned char index, Asset subscene, bool persistent ) Parameters* `index`: Index of the sub Scene slot to operate on. `subscene`: Reference to the a valid Scene Asset or `nil` to disconnect. `persistent`: Determine if the Sub Scene should be unloaded along with its parent. Return Value `true` if assigned succesfully; `false` if either the slot index is invalid or if the Asset reference provided is not a Scene.
`GetSubSceneIndex`	Retrieve the slot index where a specific Scene Asset is connected to.
Declaration int GetSubSceneIndex( const Asset subscene ) Parameters* `subscene`: Reference to the an existing Scene Asset. Return Value `-1` if the Scene Asset is not connected to any sub-scene slot; else return the slot index.
`SetSubSceneIndex`	Change the loading priority of a specific sub Scene Asset slot.
Declaration bool SetSubSceneIndex( Asset subscene, const unsigned char index ) Parameters* `subscene`: The Scene Asset to use as key to identify the slot to move. `index`: The destination where the slot pointed by `subscene` should be placed. Return Value `true` if the slot have been succesfully re-assigned else return `false` no slot is using the `subscene` received in parameter or if the destination `index` is invalid.
`RemoveSubScene`	Remove a specific sub Scene slot index using its index as key.
Declaration bool RemoveSubScene( const int index, bool force_unload ) Parameters `index`: Index of the slot to remove. `force_unload`: Force the Scene to be unloaded even if persistent (see AddSubScene ). Return Value `false` if the slot index is out of bounds; else return `true` if the slot have been removed.
`SwapSubScenes`	Swap the loading order of two sub Scene slot.
Declaration bool SwapSubScenes( unsigned char index0, unsigned char index1 ) Parameters `index0`: The source slot index. `index0`: The destination slot index. Return Value `true` if both source and destination indexes are valid and the swap occur; else return `false`.
`AddObjectGroup`	Create a new ObjectGroup and attach it to the active Scene.
Declaration ObjectGroup AddObjectGroup( const char name ) Parameters `name`: A unique name to identify the new ObjectGroup reference. Return Value A new ObjectGroup reference.
`GetObjectGroup`	Retrieve an existing ObjectGroup using its name as key.
Declaration ObjectGroup GetObjectGroup( const char name ) Parameters `name`: Index of the RenderLayer to swap. `index1`: The new index location to swap the RenderLayer to. Return Value `nil` if the `name` receive in parameter does not match any ObjectGroup entry maintained by the active Scene; else return the reference to the matching ObjectGroup.
`GetObjectGroupAt`	Return the reference of an ObjectGroup at a specific index location.
Declaration ObjectGroup GetObjectGroupAt( unsigned char index ) Parameters* `index`: The index of the ObjectGroup to retrieve. Return Value `nil` if the index is invalid; else return the reference of the ObjectGroup pointed by index.
`GetObjectGroupIndex`	Return the index of a specific ObjectGroup maintained by the active Scene.
Declaration int GetObjectGroupIndex( const ObjectGroup group ) Parameters* `group`: A valid reference to an ObjectGroup. Return Value `-1` if the ObjectGroup reference is invalid; else return its index.
`RemoveObjectGroup`	Remove an ObjectGroup associated to the current Scene.
Declaration bool RemoveObjectGroup( ObjectGroup group ) Parameters* `group`: Reference of the ObjectGroup to remove. Return Value `true` if the operation is successfull; `false` if the ObjectGroup reference is `nil` or is not attached to the active Scene.
`RemoveObjectGroupAt`	Helper to remove an existing ObjectGroup at a specific index.
Declaration bool RemoveObjectGroupAt( int index ) Parameters `index`: Index of the ObjectGroup to remove. Return Value `false` if the `index` provided is invalid or out of bounds; else return `true` upon the removal of the ObjectGroup reference.
`AddSoundGroup`	Create an attach a new SoundGroup to the current Scene.
Declaration SoundGroup AddSoundGroup( const char name ) Parameters `name`: A name to identify the new SoundGroup within the Scene. Return Value Reference of the new SoundGroup.
`GetSoundGroup`	Helper to retrieve a specific SoundGroup reference using its name as key.
Declaration SoundGroup GetSoundGroup( const char name ) Parameters `name`: The name of the SoundGroup to retrieve. Return Value `nil` if the `name` does not correspond to any SoundGroup maintained by the active Scene; else return the matching SoundGroup reference.
`GetSoundGroupAt`	Return a SoundGroup using its index as key.
Declaration SoundGroup GetSoundGroupAt( unsigned char index ) Parameters* `index`: Index of the SoundGroup to retrieve. Return Value Upon success return a valid SoundGroup reference; else return `nil` if the index provided is innexistent.
`GetSoundGroupIndex`	Function that return the index of a specific SoundGroup contained in the current Scene.
Declaration int GetSoundGroupIndex( const SoundGroup soundgroup ) Parameters* `soundgroup`: Reference to a SoundGroup maintained by the active Scene. Return Value `-1` if the reference provided is invalid; else return the index of the SoundGroup index.
`RemoveSoundGroup`	Remove a SoundGroup from the active Scene.
Declaration bool RemoveSoundGroup( SoundGroup soundgroup ) Parameters* `soundgroup`: Reference to the SoundGroup to remove. Return Value `true` on success; else return `false`.
`RemoveSoundGroupAt`	Remove a SoundGroup located at a specific index.
Declaration bool RemoveSoundGroupAt( int index ) Parameters `index`: Index of the SoundGroup to remove. Return Value `false` if the index provided is innexistent; else return `true`.
`AddVariable`	Append a new member Variable to the active Scene.
Declaration Variable AddVariable( const char name, const VariableType type ) Parameters `name`: A unique name to identify the Variable. `type`: The VariableType of the new Variable. Return Value Reference to the new Variable.
`GetVariable`	Helper to retrieve the reference to an existing Variable using its name as key.
Declaration Variable GetVariable( const char name ) Parameters `name`: Name of the Variable to retrieve. Return Value A valid Variable reference; else return `nil` if no Variable maintained by the active Scene matches the name received in parameter.
`GetVariableIndex`	Function that retrieve the index of an existing Variable.
Declaration int GetVariableIndex( const Variable variable ) Parameters* `variable`: Reference to an existing Variable maintained by the current Scene. Return Value `-1` if the `variable` reference does not exists; else return the Variable index.
`GetVariableAt`	Retrive a specific Variable reference by index.
Declaration Variable GetVariableAt( unsigned short index ) Parameters* `index`: Index of the Variable to retrieve. Return Value A valid Variable reference; else return `nil` the index is out of bounds.
`RemoveVariable`	Remove a specific member Variable from the current Scene.
Declaration bool RemoveVariable( Variable variable ) Parameters* `variable`: Variable reference to remove. Return Value `true` if the operation was successfull; else return `false`.
`RemoveVariableAt`	Remove a Variable using its index as key.
Declaration bool RemoveVariableAt( int index ) Parameters `index`: Index of the Variable to remove. Return Value `false` if the `index` provided is invalid; else return `true` if the Variable at index is removed successfully.
`AddAudioPreset`	Add a new AudioPreset to the active Scene.
Declaration AudioPreset AddAudioPreset( const char name, const AudioPresetType type ) Parameters `name`: The name to use for the new AudioPreset. `type`: Specify the AudioPresetType to use. Return Value A new reference to a valid AudioPreset attached to the current Scene.
`GetAudioPreset`	Helper that retrieves an existing AudioPreset by name.
Declaration AudioPreset GetAudioPreset( const char name ) Parameters `name`: The name of the AudioPreset to retrieve. Return Value `nil` if the `name` does not match any AudioPreset entry; else return its reference.
`GetAudioPresetAt`	Helper that return the AudioPreset reference associated to a specific index.
Declaration AudioPreset GetAudioPresetAt( unsigned char index ) Parameters* `index`: Index of the AudioPreset to retrieve. Return Value A valid AudioPreset reference on success; else return `nil` if the index provided is out of bounds.
`GetAudioPresetIndex`	Return the internal index of an existing AudioPreset reference.
Declaration int GetAudioPresetIndex( const AudioPreset audiopreset ) Parameters* `audiopreset`: The name of the AudioPreset to retrieve. Return Value `-1` if the reference provided is invalid (`nil`) or not maintained by the active Scene; else return the index associated to the reference.
`RemoveAudioPreset`	Remove an existing AudioPreset reference from the active Scene.
Declaration bool RemoveAudioPreset( AudioPreset audiopreset ) Parameters* `audiopreset`: The AudioPreset reference to remove. Return Value `true` if the operation is successfull; else return `false`.
`RemoveAudioPresetAt`	Remove by index an existing AudioPreset connected to the current Scene.
Declaration bool RemoveAudioPresetAt( int index ) Parameters `index`: Index of the AudioPreset to remove. Return Value `false` if the index provided is invalid; else return `true` to confirm that the operation is succesffull.
`AddObject`	Helper function that allows you to manually create and connect a new Object to the current Scene.
Declaration Object AddObject( const char name, const ObjectType type, const int sub_type ) Parameters `name`: A unique name to identify the new Object. `type`: The ObjectType of the new Object. `sub_type`: The sub type (based on the ObjectType) of the new Object. Return Value A valid reference to the newly created Object.
`AddEmpty`	Helper function that creates and connect a new empty Object to the active Scene.
Declaration Object AddEmpty( const char name ) Parameters `name`: A unique name to identify the new empty Object. Return Value Reference to the newly created empty Object.
`AddCamera`	Helper function that creates and connect a new Camera Object to the active Scene.
Declaration Camera AddCamera( const char name, const LensType type ) Parameters `name`: A unique name to identify the new Camera Object. `type`: The LensType to use for the new Camera. Return Value Reference to a new Camera Object.
`AddStaticMesh`	Helper function that creates and connect a new StaticMesh Object to the active Scene.
Declaration StaticMesh AddStaticMesh( const char name ) Parameters `name`: A unique name to identify the new StaticMesh Object. Return Value Reference to a new StaticMesh Object.
`AddDynamicMesh`	Helper function that creates and connect a new DynamicMesh Object to the active Scene.
Declaration DynamicMesh AddDynamicMesh( const char name ) Parameters `name`: A unique name to identify the new DynamicMesh Object. Return Value Reference to a new DynamicMesh Object.
`AddSkeletalMesh`	Helper function that creates and connect a new SkeletalMesh Object to the active Scene.
Declaration SkeletalMesh AddSkeletalMesh( const char name ) Parameters `name`: A unique name to identify the new SkeletalMesh Object. Return Value Reference to a new SkeletalMesh Object.
`AddSoundSource`	Helper function that creates and connect a new SoundSource Object to the active Scene.
Declaration SoundSource AddSoundSource( const char name, const SpeakerType type ) Parameters `name`: A unique name to identify the new SoundSource Object. `type`: The SpeakerType of the new SoundSource Object. Return Value Reference to a new SoundSource Object.
`AddLightSource`	Helper function that creates and connect a new LightSource Object to the active Scene.
Declaration LightSource AddLightSource( const char name, const SpeakerType type ) Parameters `name`: A unique name to identify the new LightSource Object. `type`: The SpeakerType of the new LightSource Object. Return Value Reference to a new LightSource Object.
`AddOccluder`	Helper function that creates and connect a new Occluder Object to the active Scene.
Declaration Occluder AddOccluder( const char name ) Parameters `name`: A unique name to identify the new Occluder Object. Return Value Reference to a new Occluder Object.
`AddText`	Helper function that creates and connect a new Text Object to the active Scene.
Declaration Text AddText( const char name ) Parameters `name`: A unique name to identify the new Text Object. Return Value Reference to a new Text Object.
`AddParticleSystem`	Helper function that creates and connect a new ParticleSystem Object to the active Scene.
Declaration ParticleSystem AddParticleSystem( const char name, const SystemType type ) Parameters `name`: A unique name to identify the new ParticleSystem Object. `type`: The SystemType to use for the new ParticleSystem. Return Value Reference to a new ParticleSystem Object.
`AddEnergyField`	Helper function that creates and connect a new EnergyField Object to the active Scene.
Declaration EnergyField AddEnergyField( const char name, const FieldType type ) Parameters `name`: A unique name to identify the new EnergyField Object. `type`: The FieldType of the new EnergyField. Return Value Reference to a new EnergyField Object.
`AddRoute`	Helper function that creates and connect a new Route Object to the active Scene.
Declaration Route AddRoute( const char name ) Parameters `name`: A unique name to identify the new Route Object. Return Value Reference to a new Route Object.
`AddRay`	Helper function that creates and connect a new Ray Object to the active Scene.
Declaration Ray AddRay( const char name, const RayType type ) Parameters `name`: A unique name to identify the new Ray Object. `type`: The RayType of the new Ray. Return Value Reference to a new Ray Object.
`AddProbe`	Helper function that creates and connect a new Probe Object to the active Scene.
Declaration Probe AddProbe( const char name, const ProbeType type ) Parameters `name`: A unique name to identify the new Probe Object. `type`: The ProbeType to use for the new Probe. Return Value Reference to a new Probe Object.
`GetObject`	Retrieve an existing Object reference attached to the current Scene.
Declaration Object GetObject( const char name ) Parameters `name`: The name of the Object to retrieve. Return Value On success return the Object reference; if the name provided does not match any Object maintained by the Scene the function will return `nil`.
`GetObjectAt`	Get a specific Object reference using an index as key.
Declaration Object GetObjectAt( unsigned int index ) Parameters* `index`: The internal index of the Object reference to retrieve. Return Value A valid Object reference on success; else return `nil` if the index is invalid.
`GetObjectIndex`	Return the internal index of an Object reference.
Declaration int GetObjectIndex( const Object object ) Parameters* `object`: A valid Object reference maintained by the current Scene. Return Value `-1` if the reference is invalid or if it is not maintained by the active Scene; else return the internal index of the Object reference.
`SetObjectIndex`	Manually change a specific Object internal index.
Declaration bool SetObjectIndex( Object object, const unsigned int index ) Parameters* `object`: Reference to a valid Object. `index`: The new index of the Object. Return Value `true` on success; `false` if either the Object reference or the index provided is invalid.
`RemoveObject`	Remove an Object from the active Scene.
Declaration bool RemoveObject( Object object, bool detach_attachments ) Parameters* `object`: The Object reference to remove from the current Scene. `detach_attachments`: Specify whether or not the Object attachments should be detached or removed. Return Value `true` on success; `false` if the Object reference received in parameter is invalid.
`RemoveObjectAt`	Remove an Object using its index as key.
Declaration bool RemoveObjectAt( int index, bool detach_attachments ) Parameters `index`: The index of the Object to remove from the current Scene. `detach_attachments`: Specify whether or not the Object attachments should be detached or removed. Return Value `true` on success; `false` if the index received in parameter is out of bounds.
`AddNavigation`	Add Navigation and pathfinding capabilities to the active Scene.
Declaration Navigation AddNavigation( void ) Return Value* Reference to the newly created Navigation structure.
`RemoveNavigation`	Remove Navigation and pathfinding capabilities from the active Scene.
Declaration bool RemoveNavigation( void ) Return Value `true` if the existing Navigation have been removed from the active Scene, else return `false` if no Navigation structure was attached to the Scene.
`Pick`	Helper to quicly pick the active Scene from a certain Camera point of view.
Declaration SceneRay Pick( const Camera camera, const RenderLayer renderlayer, const vec3 ray_from, const vec3 ray_to, const InclusionMask inclusion_mask, const bool cull_face ) Parameters `camera`: Reference to a valid Camera reference. `renderlayer_mask`: Bit mask of RenderLayer caps specifying which RenderLayer should be included in the raycast operation. `ray_from`: The starting position of the ray. `ray_to`: The end location of the ray. `inclusion_mask`: Bit mask of InclusionMask specifying the type of Object that should take part of the raycast operation. `cull_face``: Enable or disable back face culling. Note The `camera` reference does not need to be attached from the active Scene; it can be maintained by another Scene currently loaded. Return Value The raycast operation data stored in a SceneRay structure.
`Raycast`	Basic raycast function that launches a ray through the active Scene.
Declaration SceneRay Raycast( const int renderlayer_mask, const vec3 ray_from, const vec3 ray_to, const InclusionMask inclusion_mask ) Parameters `renderlayer_mask`: Bit mask of RenderLayer caps specifying which RenderLayer should be included in the raycast operation. `ray_from`: The starting position of the ray. `ray_to`: The end location of the ray. `inclusion_mask`: Bit mask of InclusionMask specifying the type of Object that should take part of the raycast operation. Return Value The raycast operation data stored in a SceneRay structure.
`Raycast`	More refined raycast function that launches a ray through the active Scene.
Declaration SceneRay Raycast( const int renderlayer_mask, const vec3 ray_from, const vec3 ray_to, const InclusionMask inclusion_mask, const Precision precision ) Parameters `renderlayer_mask`: Bit mask of RenderLayer caps specifying which RenderLayer should be included in the raycast operation. `ray_from`: The starting position of the ray. `ray_to`: The end location of the ray. `inclusion_mask`: Bit mask of InclusionMask specifying the type of Object that should take part of the raycast operation. `precision``: Specify the precision of the Object bounds to use during the raycast operation. Note Regarding precision; `kLow` will use the Object bounding sphere, `kMedium` the axis aligned bounding box and `kHigh` will either use the world bounding box or the Mesh connected to the Object (if applicable). Return Value The raycast operation data stored in a SceneRay structure.
`Raycast`	Advanced raycast function that launches a ray through the active Scene.
Declaration SceneRay Raycast( const int renderlayer_mask, const vec3 ray_from, const vec3 ray_to, const InclusionMask inclusion_mask, const Precision precision, const bool cull_face, const char filter ) Parameters* `renderlayer_mask`: Bit mask of RenderLayer caps specifying which RenderLayer should be included in the raycast operation. `ray_from`: The starting position of the ray. `ray_to`: The end location of the ray. `inclusion_mask`: Bit mask of InclusionMask specifying the type of Object that should take part of the raycast operation. `precision``: Specify the precision of the \ref Object bounds to use during the raycast operation.` `<i>`cull_face`</i>`: Enable or disable back face culling. `filter``: Substring to be tested against the Object name to validate a hit. Return Value The raycast operation data stored in a SceneRay structure.
`UpdateBounds`	Force to manually update the active Scene LocalBounds.
Declaration void UpdateBounds( void )

Events

Callbacks	Description
`OnAdd`	This event is triggered each time a new Object is added to the Scene.
Declaration function OnAdd()
`OnRemove`	Each time an Object is remove this callback is occurs.
Declaration function OnRemove()
`OnUpdate`	This callback gets called each time the Scene gets update (typically once per frame).
Declaration function OnUpdate()
`OnDraw`	Called when the Scene is about to draw the first RenderLayer.
Declaration function OnDraw()
`OnBegin`	Called when the Scene is about to draw a RenderLayer.
Declaration function OnBegin()
`OnEnd`	Triggered when the Scene is drawing a RenderLayer.
Declaration function OnEnd()
`OnDisplay`	This callback is triggered when the Scene is done drawing all RenderLayer.
Declaration function OnDisplay()

SceneRay

A structure used to store the information of a Scene raycast operation.

Static Variables

Name	Description
`hit`	Variable used that confirms a hit actually occurs.
Declaration bool hit
`hit_point`	World location of the hit.
Declaration vec3 hit_point
`hit_normal`	The normal at the hit location.
Declaration vec3 hit_normal
`primitive_index`	The primitive index intersected by the raycast operation (if any).
Declaration int primitive_index Note If the raycast operation did not hit a drawble Object this variable will be set to `-1`.
`lod_index`	The level of detail index that was intersected during the raycast operation.
Declaration int lod_index Note If the raycast operation did not hit a drawble Object this variable will be set to `-1`.
`part_index`	Store the part index that get hit by the ray.
Declaration int part_index Note Only apply when the ray intersect with FracturedMesh shards or ParticleSystem emitters.
`object`	Reference of the Object hit by the ray.
Declaration Object *object
`collider_index`	The physics Collider index hit by the ray.
Declaration int collider_index
`physicmaterial`	Reference to the PhysicMaterial Asset associated to the Collider that get hit.
Declaration PhysicMaterial *physicmaterial
`geometry`	Reference to the Geometry hit by the ray.
Declaration Geometry *geometry

DebugShapes

Controls the various flags available for shape debug drawing. All flags enable or disable a specific visual shape debugging option that will be display inside the 3d viewport (editor only).

fDrawShapes: Toggle Object debug shapes drawing.
fDrawEmpties: Draw empty Object.
fDrawCameras: Draw Camera Object.
fDrawSoundSources: Draw SoundSource Object shape.
fDrawLightSources: Draw LightSource Object shape.
fDrawParticleSystems: Draw ParticleSystem Object.
fDrawEnergyFields: Draw EnergyField Object.
fDrawRoutes: Draw Route Object.
fDrawRays: Draw Ray Object.
fDrawProbes: Draw Probe Object.
fDrawRegions: Draw Region Object.

DebugBounds

Controls the various flags available for bounds debug drawing. All flags enable or disable a specific visual bounds debugging option that will be display inside the 3d viewport (editor only).

fDrawObjectBounds: Enable or disable Object bounds drawing.
fDrawAABB: Draw the axis-aligned bounding box of an object(s).
fDrawBBox: Draw the bounding box of an object(s).
fDrawBSphere: Debug draws the bounding sphere of the object(s).
fDrawClipBounds: Debug draws the active clipping bounds used by an object(s).
fDrawSensors: Draw Sensor range of the object(s).
fDrawBoundsSelected: Restrict bounds debug draw to the current Object selection.

DebugRelations

Controls the various flags available for relations debug drawing. All flags enable or disable a specific visual relations debugging option that will be display inside the 3d viewport (editor only).

fDrawRelationships: Draw relationship lines between a parent and children object(s).
fDrawObjectRelations: Use a dashed line between parent and child to debug draw their relationship.
fDrawConstraintRelations: Enable debugs draw of object constraints.
fDrawRelationshipsSelected: Restrict constraint debug draw to the active selection.

DebugMisc

Controls the various flags available for misc. debug drawing. All flags enable or disable a specific visual miscellaneous debugging option that will be display inside the 3d viewport (editor only).

fDrawMisc: Enable or disable miscellaneous debug drawings.
fDrawPivot: Draw the Object pivot point.
fDrawCenter: Draw the Object bounding box center point.
fDrawAxis: Draw the local axis aligned axes.
fDrawOccluded: Draw using wireframes occluded drawable objects or debug shape(s).
fDrawObjectNames: Draw the name of the Object.
fDrawJointNames: Draw the Skeleton Joint name.
fDrawChunkNames: Draw the FracturedMesh Shard names.
fDrawActionPaths: Draw all location paths contained in the active Action selected.
fDrawChunkNames: Draw the FracturedMesh Shard names.
fDrawObjectGrids: Draw all ObjectGrid of the active Scene.
fDrawObjectGridsViewer: Debug draw the ViewerMethod of each active ObjectGrid.
fDrawMiscSelected: Restrict misc. drawing to the active selection only.