stingray.LODObject object reference

Description

This interface provides a Level of Detail selector: a wrapper over a number of mesh objects that selects which mesh should be rendered depending on the screen space projection of the LOD object's bounding sphere.

You set up LODObjects for your units in the Unit Editor.

Constructors and accessors

stingray.Unit.lod_object()

Other related reference items

Units

Functions

bounding_volume ( self ) : stingray.BoundingVolume Retrieves the bounding volume of the LOD object.

Parameters

self :

stingray.LODObject

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

stingray.BoundingVolume

The bounding volume of the LOD object.

set_bounding_volume ( self, bv ) Sets the bounding volume that the LOD object should use when calculating screen space coverage.

Parameters

self :	stingray.LODObject	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
bv :	stingray.BoundingVolume	The new bounding volume to set for the LOD object.

Returns

This function does not return any values.

set_orientation_node ( self, unit, node_idx ) Changes the LOD object's orientation node to the scene graph node pointed to by the unit and node.

Parameters

self :	stingray.LODObject	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
unit :	stingray.Unit	The unit to which the LOD object belongs.
node_idx :	integer	The node index in the unit's scene graph to use for the orientation of the LOD object.

Returns

This function does not return any values.

set_static_select ( self, select ) Forces a static LOD step to be used.

Parameters

self :	stingray.LODObject	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
select :	integer	The selection type for LOD.

Returns

This function does not return any values.

Set to -1 to re-enable dynamic LOD selection.

Scene placement

The functions in this group control the placement of an object of this type in the scene.

local_pose ( self ) : stingray.Matrix4x4 Returns the position and orientation of the specified scene graph object in local space: i.e. relative to its parent in the scene graph.

Parameters

self :

stingray.LODObject

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

stingray.Matrix4x4

The position and orientation of the object in local space.

local_position ( self ) : stingray.Vector3 Returns the position of the specified scene graph object in local space: i.e. relative to its parent in the scene graph.

Parameters

self :

stingray.LODObject

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

stingray.Vector3

The position of the object in local space.

local_rotation ( self ) : stingray.Quaternion Returns the orientation of the specified scene graph object in local space: i.e. relative to its parent in the scene graph.

Parameters

self :

stingray.LODObject

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

stingray.Quaternion

The rotation of the object in local space.

node ( self ) : integer Returns the ID of the specified object within the scene graph.

Parameters

self :

stingray.LODObject

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

integer

The ID of the specified object in the scene graph.

set_local_pose ( self, parent, pose ) Sets the position and orientation of the specified scene graph object in local space: i.e. relative to its parent in the scene graph.

Parameters

self :	stingray.LODObject	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
parent :	stingray.Unit	The parent Unit that owns this object.
pose :	stingray.Matrix4x4	The new position and orientation for the object in local space.

Returns

This function does not return any values.

set_local_position ( self, parent, position ) Sets the position of the specified scene graph object in local space: i.e. relative to its parent in the scene graph.

Parameters

self :	stingray.LODObject	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
parent :	stingray.Unit	The parent Unit that owns this object.
position :	stingray.Vector3	The new position for the object in local space.

Returns

This function does not return any values.

set_local_rotation ( self, parent, rotation ) Sets the orientation of the specified scene graph object in local space: i.e. relative to its parent in the scene graph.

Parameters

self :	stingray.LODObject	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
parent :	stingray.Unit	The parent Unit that owns this object.
rotation :	stingray.Quaternion	The new rotation for the object in local space.

Returns

This function does not return any values.

world_pose ( self ) : stingray.Matrix4x4 Returns the position and orientation of the specified scene graph object in world space.

Parameters

self :

stingray.LODObject

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

stingray.Matrix4x4

The position and orientation of the object in world space.

world_position ( self ) : stingray.Vector3 Returns the position of the specified scene graph object in world space.

Parameters

self :

stingray.LODObject

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

stingray.Vector3

The position of the object in world space.

world_rotation ( self ) : stingray.Quaternion Returns the rotation of the specified scene graph object in world space.

Parameters

self :

stingray.LODObject

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

stingray.Quaternion

The rotation of the object in world space.