Object/Node

Functions
int	SO3ObjectRotate (mmachine m)
	main include
int	SO3ObjectShowBoundingBox (mmachine m)
	SO3ObjectShowBoundingBox : Allow the display of BoundingBox.
int	SO3ObjectSetDirection (mmachine m)
	SO3ObjectSetDirection : defines direction of a node.
int	SO3ObjectGetDirection (mmachine m)
	SO3ObjectGetDirection : Get the node direction.
int	SO3ObjectGetDerivedDirection (mmachine m)
	SO3ObjectGetDerivedDirection : Get the node derived direction.
int	SO3ObjectGetDirectionAxis (mmachine m)
	SO3ObjectGetDirectionAxis : Get the node direction from axis.
int	SO3ObjectGetDerivedDirectionAxis (mmachine m)
	SO3ObjectGetDerivedDirectionAxis : Get the node derived direction from axis.
int	SO3ObjectLookAt (mmachine m)
	SO3ObjectLookAt : defines "look at" direction of a node.
int	SO3ObjectSetVisible (mmachine m)
	SO3ObjectSetVisible : defines visible state of a node.
int	SO3ObjectGetVisible (mmachine m)
	SO3ObjectGetVisible : Get the visible state of a node.
int	SO3ObjectGetName (mmachine m)
	SO3ObjectGetName : Return a node's name.
int	SO3ObjectSetOrientation (mmachine m)
	SO3ObjectSetOrientation : Set an orientation for a given node.
int	SO3ObjectAddOrientation (mmachine m)
	SO3ObjectAddOrientation : Add orientation to a given node.
int	SO3ObjectResetToInitialOrientation (mmachine m)
	SO3ObjectResetToInitialOrientation : Reset node orientation.
int	SO3ObjectSetPosition (mmachine m)
	SO3ObjectSetPosition : defines position for a given node.
int	SO3ObjectTranslate (mmachine m)
	SO3ObjectTranslate : Translate a given node.
int	SO3ObjectSetScale (mmachine m)
	SO3ObjectSetScale : Scale a given node.
int	SO3ObjectGetOrientation (mmachine m)
	SO3ObjectGetOrientation : Get Object Orientation.
int	SO3ObjectGetInitialOrientation (mmachine m)
	SO3ObjectGetInitialOrientation : Get Initial Object Orientation.
int	SO3ObjectGetGlobalOrientation (mmachine m)
	SO3ObjectGetGlobalOrientation : Get Global Object Orientation.
int	SO3ObjectSetGlobalPosition (mmachine m)
	SO3ObjectSetGlobalPosition : Set Global Object Postion.
int	SO3ObjectSetGlobalOrientation (mmachine m)
	SO3ObjectSetGlobalOrientation : Set Global Object Orientation.
int	SO3ObjectSetGlobalScale (mmachine m)
	SO3ObjectSetGlobalScale : Set Global Object scale.
int	SO3ObjectGetPosition (mmachine m)
	SO3ObjectGetPosition : Get Object Position.
int	SO3ObjectGetInitialPosition (mmachine m)
	SO3ObjectGetInitialPosition : Get Object Initial Position.
int	SO3ObjectGetGlobalPosition (mmachine m)
	SO3ObjectGetGlobalPosition : Get Object Global Position.
int	SO3ObjectGetScale (mmachine m)
	SO3ObjectGetScale : Get Object Scale.
int	SO3ObjectGetInitialScale (mmachine m)
	SO3ObjectGetScale : Get Object Initial Scale.
int	SO3ObjectGetMatrix (mmachine m)
	SO3ObjectGetMatrix : Return the matrix of a given node.
int	SO3ObjectGetWorldMatrix (mmachine m)
	SO3ObjectGetWorldMatrix : Return the world matrix of a given node.
int	SO3ObjectGetGlobalScale (mmachine m)
	SO3ObjectGetScale : Get Object Global Scale.
int	SO3ObjectRotateRoll (mmachine m)
	SO3ObjectRotateRoll : Roll a node.
int	SO3ObjectRotateYaw (mmachine m)
	SO3ObjectRotateYaw : Yaw a node.
int	SO3ObjectRotatePitch (mmachine m)
	SO3ObjectRotatePitch : Pitch a node.
int	SO3ObjectNbOfChild (mmachine m)
	SO3ObjectNbOfChild : return the numer of child of a node.
int	SO3ObjectRemoveAllChildren (mmachine m)
	SO3ObjectRemoveAllChildren : Remove all children.
int	SO3ObjectGetChildren (mmachine m)
	SO3ObjectGetChildren : Return the list of child node.
int	SO3ObjectDestroy (mmachine m)
	SO3ObjectDestroy : Destroy a node and its hierarchy.
int	SO3ObjectSetInitialState (mmachine m)
	SO3ObjectSetInitialState : defines initial state of a node.
int	SO3ObjectResetToInitialState (mmachine m)
	SO3ObjectResetToInitialState : Reset a node to its initial state.
int	SO3ObjectGetSceneRoot (mmachine m)
	SO3ObjectGetSceneRoot : Get the scene root node.
int	SO3ObjectGetParent (mmachine m)
	SO3ObjectGetParent : Get the parent node of a node.
int	SO3ObjectGetScene (mmachine m)
	SO3ObjectGetScene : Get the parent scene of a node.
int	SO3ObjectLink (mmachine m)
	SO3ObjectLink : Link two nodes.
int	SO3ObjectGetPositionInObjectRef (mmachine m)
	SO3ObjectGetPositionInObjectRef : Return the position of node in the transform space of another node.
int	SO3ObjectGetOrientationInObjectRef (mmachine m)
	SO3ObjectGetOrientationInObjectRef : Return the orientation of node in the transform space of another node.
int	SO3ObjectGetScaleInObjectRef (mmachine m)
	SO3ObjectGetScaleInObjectRef : Return the scale of node in the transform space of another node.
int	SO3ObjectUnlink (mmachine m)
	SO3ObjectUnlink : Unlink a node from the scene.
int	SO3ObjectSetAutoTracking (mmachine m)
	SO3ObjectSetAutoTracking : defines auto tracking for a node.
int	SO3ObjectSetRenderingDistance (mmachine m)
	SO3ObjectSetRenderingDistance : defines a maximum distance for rendering the object.
int	SO3ObjectGetRenderingDistance (mmachine m)
	SO3ObjectGetRenderingDistance : return the maximum distance for rendering the object.
int	SO3ObjectSetCastShadows (mmachine m)
	SO3ObjectSetCastShadows : defines cast shadow state for a node.
int	SO3ObjectGetBoundingBoxInfo (mmachine m)
	SO3ObjectGetBoundingBoxInfo : Return the bounding box information of a node.
int	SO3ObjectGetWorldBoundingBoxInfo (mmachine m)
	SO3ObjectGetWorldBoundingBoxInfo : Return the world bounding box information of a node.
int	SO3ObjectGetCastShadows (mmachine m)
	SO3ObjectGetCastShadows : Get the cast shadows state of a node.
int	SO3ObjectGetPolygonCount (mmachine m)
	SO3ObjectGetPolygonCount : Return the numer of Polygone for a node.
int	SO3ObjectGetVerticesCount (mmachine m)
	SO3ObjectGetVerticesCount : Return the numer of Vertex for a node.
int	SO3ObjectSetMouseForeGround (mmachine m)
	SO3ObjectSetMouseForeGround : defines mouse foreground priority of a node.
int	SO3ObjectSetMouseClick (mmachine m)
	SO3ObjectSetMouseClick : defines mouse click state of a node.
int	SO3ObjectGetMouseForeGround (mmachine m)
	SO3ObjectGetMouseForeGround :Get the mouse foreground priority of a node.
int	SO3ObjectGetMouseClick (mmachine m)
	SO3ObjectGetMouseClick :Get the mouse click state of a node.
int	SO3ObjectSetFlags (mmachine m)
	SO3ObjectSetFlags : defines any flags value on a node.
int	SO3ObjectGetFlags (mmachine m)
	SO3ObjectGetFlags : Get a node flags value.
int	SO3ObjectSetRenderOverlay (mmachine m)
	SO3ObjectSetRenderOverlay : defines render overlay priority of a mesh.
int	SO3ObjectSetRenderQueue (mmachine m)
	SO3ObjectSetRenderQueue : defines render queue position of a mesh.
int	SO3ObjectGetInfo (mmachine m)
	SO3ObjectGetInfo : Get mouse informations (raycast) from a viewport.
int	SO3ObjectGetInfoEx (mmachine m)
	SO3ObjectGetInfoEx : Get extended mouse informations (raycast) from a viewport.
int	SO3ObjectGetScreenCoord (mmachine m)
	SO3ObjectGetScreenCoord : Get screen coordinates of a node.
int	SO3ObjectGetScreenPixelCoord (mmachine m)
	SO3ObjectGetScreenPixelCoord : Get screen coordinates in pixels of a node.
int	SO3ObjectGetNodeFacingOrientation (mmachine m)
	SO3ObjectGetNodeFacingOrientation : Get the necessary rotation for making the target node facing the destination node in global space.
int	SO3ObjectGetAnimation (mmachine m)
	SO3ObjectGetAnimation : return an animation by its name.
int	SO3ObjectSetInheritOrientation (mmachine m)
	SO3ObjectSetInheritOrientation : Set the inherit orientation of a node.
int	SO3ObjectGetInheritOrientation (mmachine m)
	SO3ObjectGetInheritOrientation : Get the inherit orientation of a node.
int	SO3ObjectResetOrientation (mmachine m)
	SO3ObjectResetOrientation : Resets the node orientation (local axes as world axes, no rotation)
int	SO3ObjectSetAsStaticGeometry (mmachine m)
	SO3ObjectSetAsStaticGeometry : Set the object as a static geometry.
int	SO3ObjectGetAsStaticGeometry (mmachine m)
	SO3ObjectGetAsStaticGeometry : Get the static gemoetry state of a node.
int	SO3ObjectGetType (mmachine m)
	SO3ObjectGetType : Get the type of an object.

Detailed Description

Scol functions definition

Function Documentation

SO3ObjectAddOrientation()

int SO3ObjectAddOrientation

(

mmachine

m

)

SO3ObjectAddOrientation : Add orientation to a given node.

Prototype: fun [SO3_OBJECT [F F F F]] I

Parameters

SO3_OBJECT	: current node
[F	F F F] : orientation (quaternion)

Returns

I : 1 if success , NIL otherwise

Definition at line 681 of file SCOLObject.cpp.

SO3ObjectDestroy()

int SO3ObjectDestroy

(

mmachine

m

)

SO3ObjectDestroy : Destroy a node and its hierarchy.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : 1 if success , NIL otherwise

Definition at line 1906 of file SCOLObject.cpp.

SO3ObjectGetAnimation()

int SO3ObjectGetAnimation

(

mmachine

m

)

SO3ObjectGetAnimation : return an animation by its name.

Prototype: fun [SO3_OBJECT S] SO3_ANIM

Parameters

SO3_OBJECT	: current node
S	: given name

Returns

SO3_ANIM : animation if success, NIL otherwise

Definition at line 3924 of file SCOLObject.cpp.

SO3ObjectGetAsStaticGeometry()

int SO3ObjectGetAsStaticGeometry

(

mmachine

m

)

SO3ObjectGetAsStaticGeometry : Get the static gemoetry state of a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : state 1 if enable, 0 if disable, NIL otherwise

Definition at line 4192 of file SCOLObject.cpp.

SO3ObjectGetBoundingBoxInfo()

int SO3ObjectGetBoundingBoxInfo

(

mmachine

m

)

SO3ObjectGetBoundingBoxInfo : Return the bounding box information of a node.

Prototype: fun [SO3_OBJECT I] [[F F F] [F F F] [F F F F]]

Parameters

SO3_OBJECT	: current node
I	: take the childs for calculate the bounding box

Returns

[[F F F] [F F F] [F F F F]] : Bounding box information if success , NIL otherwise

• Size
• Position
• Orientation

Definition at line 2670 of file SCOLObject.cpp.

SO3ObjectGetCastShadows()

int SO3ObjectGetCastShadows

(

mmachine

m

)

SO3ObjectGetCastShadows : Get the cast shadows state of a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : Cast shadows state (1 enable, 0 disable) if success , NIL otherwise

Definition at line 2917 of file SCOLObject.cpp.

SO3ObjectGetChildren()

int SO3ObjectGetChildren

(

mmachine

m

)

SO3ObjectGetChildren : Return the list of child node.

Prototype: fun [SO3_OBJECT] [SO3_OBJECT r1]

Parameters

SO3_OBJECT

: current node

Returns

[SO3_OBJECT r1] : list of child Node if success , NIL otherwise

Definition at line 1841 of file SCOLObject.cpp.

SO3ObjectGetDerivedDirection()

int SO3ObjectGetDerivedDirection

(

mmachine

m

)

SO3ObjectGetDerivedDirection : Get the node derived direction.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Direction if success , NIL otherwise

Definition at line 274 of file SCOLObject.cpp.

SO3ObjectGetDerivedDirectionAxis()

int SO3ObjectGetDerivedDirectionAxis

(

mmachine

m

)

SO3ObjectGetDerivedDirectionAxis : Get the node derived direction from axis.

Prototype: fun [SO3_OBJECT [F F F]] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Direction if success , NIL otherwise

Definition at line 376 of file SCOLObject.cpp.

SO3ObjectGetDirection()

int SO3ObjectGetDirection

(

mmachine

m

)

SO3ObjectGetDirection : Get the node direction.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Direction if success , NIL otherwise

Definition at line 229 of file SCOLObject.cpp.

SO3ObjectGetDirectionAxis()

int SO3ObjectGetDirectionAxis

(

mmachine

m

)

SO3ObjectGetDirectionAxis : Get the node direction from axis.

Prototype: fun [SO3_OBJECT [F F F]] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Direction if success , NIL otherwise

Definition at line 319 of file SCOLObject.cpp.

SO3ObjectGetFlags()

int SO3ObjectGetFlags

(

mmachine

m

)

SO3ObjectGetFlags : Get a node flags value.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : current flags value if success, NIL otherwise

Definition at line 3275 of file SCOLObject.cpp.

SO3ObjectGetGlobalOrientation()

int SO3ObjectGetGlobalOrientation

(

mmachine

m

)

SO3ObjectGetGlobalOrientation : Get Global Object Orientation.

Prototype: fun [SO3_OBJECT] [F F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F F] : Object Global Orientation if success , NIL otherwise

Definition at line 1027 of file SCOLObject.cpp.

SO3ObjectGetGlobalPosition()

int SO3ObjectGetGlobalPosition

(

mmachine

m

)

SO3ObjectGetGlobalPosition : Get Object Global Position.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Object Global Position if success , NIL otherwise

Definition at line 1319 of file SCOLObject.cpp.

SO3ObjectGetGlobalScale()

int SO3ObjectGetGlobalScale

(

mmachine

m

)

SO3ObjectGetScale : Get Object Global Scale.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Object Global Scale if success , NIL otherwise

Definition at line 1584 of file SCOLObject.cpp.

SO3ObjectGetInfo()

int SO3ObjectGetInfo

(

mmachine

m

)

SO3ObjectGetInfo : Get mouse informations (raycast) from a viewport.

Prototype: fun [SO3_VIEWPORT I I] [SO3_OBJECT SO3_MATERIAL I]

Parameters

SO3_VIEWPORT	: viewport for raycast
I	: X mouse position
I	: Y mouse position

Returns

[SO3_OBJECT SO3_MATERIAL I] : mouse informations if success , NIL otherwise

• Object under raycast
• Material under raycast
• SubEntity index under raycast

Definition at line 3417 of file SCOLObject.cpp.

SO3ObjectGetInfoEx()

int SO3ObjectGetInfoEx

(

mmachine

m

)

SO3ObjectGetInfoEx : Get extended mouse informations (raycast) from a viewport.

Prototype: fun [SO3_VIEWPORT I I] [SO3_OBJECT SO3_MATERIAL I F I [F F F] [F F F] [F F F] [F F] [F F] [F F] [F F F] [F F]]

Parameters

SO3_VIEWPORT	: viewport for raycast
I	: X mouse position
I	: Y mouse position

Returns

[SO3_OBJECT SO3_MATERIAL I] : extended mouse informations if success , NIL otherwise

• Object under raycast
• Material under raycast
• SubEntity index under raycast
• Distance
• Face index
• Vertex 1 of the face
• Vertex 2 of the face
• Vertex 3 of the face
• UV/Vertex1 coordinates
• UV/Vertex2 coordinates
• UV/Vertex3 coordinates
• Point coordinates
• UV/Point Coordinates

Definition at line 3487 of file SCOLObject.cpp.

SO3ObjectGetInheritOrientation()

int SO3ObjectGetInheritOrientation

(

mmachine

m

)

SO3ObjectGetInheritOrientation : Get the inherit orientation of a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : state 1 if enable, 0 if disable, NIL otherwise

Definition at line 4073 of file SCOLObject.cpp.

SO3ObjectGetInitialOrientation()

int SO3ObjectGetInitialOrientation

(

mmachine

m

)

SO3ObjectGetInitialOrientation : Get Initial Object Orientation.

Prototype: fun [SO3_OBJECT] [F F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F F] : Object Initial Orientation if success , NIL otherwise

Definition at line 979 of file SCOLObject.cpp.

SO3ObjectGetInitialPosition()

int SO3ObjectGetInitialPosition

(

mmachine

m

)

SO3ObjectGetInitialPosition : Get Object Initial Position.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Object Initial Position if success , NIL otherwise

Definition at line 1272 of file SCOLObject.cpp.

SO3ObjectGetInitialScale()

int SO3ObjectGetInitialScale

(

mmachine

m

)

SO3ObjectGetScale : Get Object Initial Scale.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Object Initial Scale if success , NIL otherwise

Definition at line 1413 of file SCOLObject.cpp.

SO3ObjectGetMatrix()

int SO3ObjectGetMatrix

(

mmachine

m

)

SO3ObjectGetMatrix : Return the matrix of a given node.

Prototype: fun [SO3_OBJECT] [F F F F F F F F F F F F F F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F F F F F F F F F F F F F F] : Object Matrix if success , NIL otherwise

Definition at line 1460 of file SCOLObject.cpp.

SO3ObjectGetMouseClick()

int SO3ObjectGetMouseClick

(

mmachine

m

)

SO3ObjectGetMouseClick :Get the mouse click state of a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : mouse click state (1 enable, 0 disable) if success , NIL otherwise

Definition at line 3192 of file SCOLObject.cpp.

SO3ObjectGetMouseForeGround()

int SO3ObjectGetMouseForeGround

(

mmachine

m

)

SO3ObjectGetMouseForeGround :Get the mouse foreground priority of a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : mouse foreground priority (1 enable, 0 disable) if success , NIL otherwise

Definition at line 3146 of file SCOLObject.cpp.

SO3ObjectGetName()

int SO3ObjectGetName

(

mmachine

m

)

SO3ObjectGetName : Return a node's name.

Prototype: fun [SO3_OBJECT] S

Parameters

SO3_OBJECT

: current node

Returns

S : node's name if success , NIL otherwise

Definition at line 596 of file SCOLObject.cpp.

SO3ObjectGetNodeFacingOrientation()

int SO3ObjectGetNodeFacingOrientation

(

mmachine

m

)

SO3ObjectGetNodeFacingOrientation : Get the necessary rotation for making the target node facing the destination node in global space.

Prototype: fun [SO3_OBJECT SO3_OBJECT [F F F] [I I I]] [F F F F]

Parameters

SO3_OBJECT	: source node
SO3_OBJECT	: destination node
[F	F F] : object natural facing (nil for default negative Z)
[I	I I] : axis to rotate (nil for default XYZ)

Returns

(F F F F] : Rotation quaternion if success , NIL otherwise

Definition at line 3801 of file SCOLObject.cpp.

SO3ObjectGetOrientation()

int SO3ObjectGetOrientation

(

mmachine

m

)

SO3ObjectGetOrientation : Get Object Orientation.

Prototype: fun [SO3_OBJECT] [F F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F F] : Object Orientation if success , NIL otherwise

Definition at line 931 of file SCOLObject.cpp.

SO3ObjectGetOrientationInObjectRef()

int SO3ObjectGetOrientationInObjectRef

(

mmachine

m

)

SO3ObjectGetOrientationInObjectRef : Return the orientation of node in the transform space of another node.

Prototype:fun [SO3_OBJECT SO3_OBJECT] [F F F F]

Parameters

SO3_OBJECT	: child node
SO3_OBJECT	: father node

Returns

[F F F F] : Orientation if success , NIL otherwise

Definition at line 2263 of file SCOLObject.cpp.

SO3ObjectGetParent()

int SO3ObjectGetParent

(

mmachine

m

)

SO3ObjectGetParent : Get the parent node of a node.

Prototype: fun [SO3_OBJECT] SO3_OBJECT

Parameters

SO3_OBJECT

: current node

Returns

SO3_OBJECT : Parent if success , NIL otherwise

Definition at line 2051 of file SCOLObject.cpp.

SO3ObjectGetPolygonCount()

int SO3ObjectGetPolygonCount

(

mmachine

m

)

SO3ObjectGetPolygonCount : Return the numer of Polygone for a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : Number of Polygone if success , NIL otherwise

Definition at line 2966 of file SCOLObject.cpp.

SO3ObjectGetPosition()

int SO3ObjectGetPosition

(

mmachine

m

)

SO3ObjectGetPosition : Get Object Position.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Object Position if success , NIL otherwise

Definition at line 1225 of file SCOLObject.cpp.

SO3ObjectGetPositionInObjectRef()

int SO3ObjectGetPositionInObjectRef

(

mmachine

m

)

SO3ObjectGetPositionInObjectRef : Return the position of node in the transform space of another node.

Prototype:fun [SO3_OBJECT SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT	: child node
SO3_OBJECT	: father node

Returns

[F F F] : Position if success , NIL otherwise

Definition at line 2212 of file SCOLObject.cpp.

SO3ObjectGetRenderingDistance()

int SO3ObjectGetRenderingDistance

(

mmachine

m

)

SO3ObjectGetRenderingDistance : return the maximum distance for rendering the object.

Prototype: fun [SO3_OBJECT] F

Parameters

SO3_OBJECT

: current node

Returns

F : The maximum object rendering distance NIL otherwise

Definition at line 2568 of file SCOLObject.cpp.

SO3ObjectGetScale()

int SO3ObjectGetScale

(

mmachine

m

)

SO3ObjectGetScale : Get Object Scale.

Prototype: fun [SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F] : Object Scale if success , NIL otherwise

Definition at line 1366 of file SCOLObject.cpp.

SO3ObjectGetScaleInObjectRef()

int SO3ObjectGetScaleInObjectRef

(

mmachine

m

)

SO3ObjectGetScaleInObjectRef : Return the scale of node in the transform space of another node.

Prototype:fun [SO3_OBJECT SO3_OBJECT] [F F F]

Parameters

SO3_OBJECT	: child node
SO3_OBJECT	: father node

Returns

[F F F] : scale if success , NIL otherwise

Definition at line 2315 of file SCOLObject.cpp.

SO3ObjectGetScene()

int SO3ObjectGetScene

(

mmachine

m

)

SO3ObjectGetScene : Get the parent scene of a node.

Prototype: fun [SO3_OBJECT] SO3_SCENE

Parameters

SO3_OBJECT

: current node

Returns

SO3_SCENE : Parent scene if success , NIL otherwise

Definition at line 2098 of file SCOLObject.cpp.

SO3ObjectGetSceneRoot()

int SO3ObjectGetSceneRoot

(

mmachine

m

)

SO3ObjectGetSceneRoot : Get the scene root node.

Prototype: fun [SO3_SCENE] SO3_OBJECT

Parameters

SO3_SCENE

: current scene

Returns

SO3_OBJECT : Scene root node if success , NIL otherwise

Definition at line 2012 of file SCOLObject.cpp.

SO3ObjectGetScreenCoord()

int SO3ObjectGetScreenCoord

(

mmachine

m

)

SO3ObjectGetScreenCoord : Get screen coordinates of a node.

Prototype: fun [SO3_OBJECT SO3_VIEWPORT] [F F]

Parameters

SO3_VIEWPORT

: viewport for raycast

Returns

[F F] : Screen coordinates of a node if success , NIL otherwise

Definition at line 3641 of file SCOLObject.cpp.

SO3ObjectGetScreenPixelCoord()

int SO3ObjectGetScreenPixelCoord

(

mmachine

m

)

SO3ObjectGetScreenPixelCoord : Get screen coordinates in pixels of a node.

Prototype: fun [SO3_OBJECT SO3_VIEWPORT] [I I]

Parameters

SO3_VIEWPORT	: viewport
SO3_OBJECT	: object node

Returns

[I I] : Screen coordinates of a node in pixel if success , NIL otherwise

Definition at line 3718 of file SCOLObject.cpp.

SO3ObjectGetType()

int SO3ObjectGetType

(

mmachine

m

)

SO3ObjectGetType : Get the type of an object.

types are :

• SO3_TYPE_NODE
• SO3_TYPE_ENTITY
• SO3_TYPE_CAMERA
• SO3_TYPE_LIGHT
• SO3_TYPE_SKELETON
• SO3_TYPE_BONE
• SO3_TYPE_PARTICLE
• SO3_TYPE_CUBE_MAP
• SO3_TYPE_REFLECTION_MAP
• SO3_TYPE_RENDER_TO_TEXTURE
• SO3_TYPE_LINE_ENTITY
• SO3_TYPE_VIRTUAL_POINTER

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : the object type on success, NIL otherwise

Definition at line 4239 of file SCOLObject.cpp.

SO3ObjectGetVerticesCount()

int SO3ObjectGetVerticesCount

(

mmachine

m

)

SO3ObjectGetVerticesCount : Return the numer of Vertex for a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : Number of Vertex if success , NIL otherwise

Definition at line 3008 of file SCOLObject.cpp.

SO3ObjectGetVisible()

int SO3ObjectGetVisible

(

mmachine

m

)

SO3ObjectGetVisible : Get the visible state of a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : boolean (1 visible, 0 not) if success , NIL otherwise

Definition at line 550 of file SCOLObject.cpp.

SO3ObjectGetWorldBoundingBoxInfo()

int SO3ObjectGetWorldBoundingBoxInfo

(

mmachine

m

)

SO3ObjectGetWorldBoundingBoxInfo : Return the world bounding box information of a node.

Prototype: fun [SO3_OBJECT I] [[F F F] [F F F] [F F F F]]

Parameters

SO3_OBJECT	: current node
I	: take the childs for calculate the bounding box

Returns

[[F F F] [F F F] [F F F F]] : Bounding box information if success , NIL otherwise

• Size
• Position
• Orientation

Definition at line 2796 of file SCOLObject.cpp.

SO3ObjectGetWorldMatrix()

int SO3ObjectGetWorldMatrix

(

mmachine

m

)

SO3ObjectGetWorldMatrix : Return the world matrix of a given node.

Prototype: fun [SO3_OBJECT] [F F F F F F F F F F F F F F F F]

Parameters

SO3_OBJECT

: current node

Returns

[F F F F F F F F F F F F F F F F] : Object world Matrix if success , NIL otherwise

Definition at line 1524 of file SCOLObject.cpp.

SO3ObjectLink()

int SO3ObjectLink

(

mmachine

m

)

SO3ObjectLink : Link two nodes.

Prototype: fun [SO3_OBJECT SO3_OBJECT] I

Parameters

SO3_OBJECT	: child node
SO3_OBJECT	: new father node

Returns

I : 1 if success, NIL otherwise

Definition at line 2146 of file SCOLObject.cpp.

SO3ObjectLookAt()

int SO3ObjectLookAt

(

mmachine

m

)

SO3ObjectLookAt : defines "look at" direction of a node.

Prototype: fun [SO3_OBJECT [F F F] I] I

Parameters

SO3_OBJECT	: current node
[F	F F] : current direction "look at"
I	: Transform space

For transform space, values are :

• SO3_LOCAL_TS
• SO3_PARENT_TS
• SO3_WORLD_TS

Returns

I : 1 if success , NIL otherwise

Definition at line 440 of file SCOLObject.cpp.

SO3ObjectNbOfChild()

int SO3ObjectNbOfChild

(

mmachine

m

)

SO3ObjectNbOfChild : return the numer of child of a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : Number of Child if success , NIL otherwise

Definition at line 1768 of file SCOLObject.cpp.

SO3ObjectRemoveAllChildren()

int SO3ObjectRemoveAllChildren

(

mmachine

m

)

SO3ObjectRemoveAllChildren : Remove all children.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : 1 if success , NIL otherwise

Definition at line 1805 of file SCOLObject.cpp.

SO3ObjectResetOrientation()

int SO3ObjectResetOrientation

(

mmachine

m

)

SO3ObjectResetOrientation : Resets the node orientation (local axes as world axes, no rotation)

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : 1 if success, NIL otherwise

Definition at line 4106 of file SCOLObject.cpp.

SO3ObjectResetToInitialOrientation()

int SO3ObjectResetToInitialOrientation

(

mmachine

m

)

SO3ObjectResetToInitialOrientation : Reset node orientation.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : 1 if success , NIL otherwise

Definition at line 731 of file SCOLObject.cpp.

SO3ObjectResetToInitialState()

int SO3ObjectResetToInitialState

(

mmachine

m

)

SO3ObjectResetToInitialState : Reset a node to its initial state.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : 1 if success , NIL otherwise

Definition at line 1974 of file SCOLObject.cpp.

SO3ObjectRotate()

int SO3ObjectRotate

(

mmachine

m

)

main include

SO3ObjectRotate : Rotate a node

Prototype: fun [SO3_OBJECT F [F F F] I] I

Parameters

SO3_OBJECT	: current node
F	: rotation value
[F	F F] : vector that defines the rotation axes
I	: Transform space

For transform space, values are :

• SO3_LOCAL_TS
• SO3_PARENT_TS
• SO3_WORLD_TS

Returns

I : 1 if success , NIL otherwise

Definition at line 69 of file SCOLObject.cpp.

SO3ObjectRotatePitch()

int SO3ObjectRotatePitch

(

mmachine

m

)

SO3ObjectRotatePitch : Pitch a node.

Prototype: fun [SO3_OBJECT F I] I

Parameters

SO3_OBJECT	: current node
F	: Pitch value
I	: Transform space

For transform space, values are :

• SO3_LOCAL_TS
• SO3_PARENT_TS
• SO3_WORLD_TS

Returns

I : 1 if success , NIL otherwise

Definition at line 1729 of file SCOLObject.cpp.

SO3ObjectRotateRoll()

int SO3ObjectRotateRoll

(

mmachine

m

)

SO3ObjectRotateRoll : Roll a node.

Prototype: fun [SO3_OBJECT F I] I

Parameters

SO3_OBJECT	: current node
F	: Roll value
I	: Transform space

For transform space, values are :

• SO3_LOCAL_TS
• SO3_PARENT_TS
• SO3_WORLD_TS

Returns

I : 1 if success , NIL otherwise

Definition at line 1638 of file SCOLObject.cpp.

SO3ObjectRotateYaw()

int SO3ObjectRotateYaw

(

mmachine

m

)

SO3ObjectRotateYaw : Yaw a node.

Prototype: fun [SO3_OBJECT F I] I

Parameters

SO3_OBJECT	: current node
F	: Yaw value
I	: Transform space

For transform space, values are :

• SO3_LOCAL_TS
• SO3_PARENT_TS
• SO3_WORLD_TS

Returns

I : 1 if success , NIL otherwise

Definition at line 1683 of file SCOLObject.cpp.

SO3ObjectSetAsStaticGeometry()

int SO3ObjectSetAsStaticGeometry

(

mmachine

m

)

SO3ObjectSetAsStaticGeometry : Set the object as a static geometry.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current node
I	: state, 1 to enable, 0 to disable static geometry

Returns

I : 1 if success, NIL otherwise

Definition at line 4143 of file SCOLObject.cpp.

SO3ObjectSetAutoTracking()

int SO3ObjectSetAutoTracking

(

mmachine

m

)

SO3ObjectSetAutoTracking : defines auto tracking for a node.

Prototype: fun [SO3_OBJECT SO3_OBJECT I [F F F] [F F F]] I

Parameters

SO3_OBJECT	: current node
SO3_OBJECT	: target node
[F	F F] : Direction
[F	F F] : Offset

Returns

I : 1 if success , NIL otherwise

Definition at line 2406 of file SCOLObject.cpp.

SO3ObjectSetCastShadows()

int SO3ObjectSetCastShadows

(

mmachine

m

)

SO3ObjectSetCastShadows : defines cast shadow state for a node.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current node
I	: 1 enable, 0 disable

Returns

I : 1 if success , NIL otherwise

Definition at line 2616 of file SCOLObject.cpp.

SO3ObjectSetDirection()

int SO3ObjectSetDirection

(

mmachine

m

)

SO3ObjectSetDirection : defines direction of a node.

Prototype: fun [SO3_OBJECT [F F F] I] I

Parameters

SO3_OBJECT	: current node
[F	F F] : current direction vector
I	: Transform space

For transform space, values are :

• SO3_LOCAL_TS
• SO3_PARENT_TS
• SO3_WORLD_TS

Returns

I : 1 if success , NIL otherwise

Definition at line 173 of file SCOLObject.cpp.

SO3ObjectSetFlags()

int SO3ObjectSetFlags

(

mmachine

m

)

SO3ObjectSetFlags : defines any flags value on a node.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current node
I	: new flags value

Returns

I : 1 if success , NIL otherwise

Definition at line 3239 of file SCOLObject.cpp.

SO3ObjectSetGlobalOrientation()

int SO3ObjectSetGlobalOrientation

(

mmachine

m

)

SO3ObjectSetGlobalOrientation : Set Global Object Orientation.

Prototype: fun [SO3_OBJECT [F F F F]] I

Parameters

SO3_OBJECT	: current node
[F	F F F] : orientation (quaternion)

Returns

I : 1 if success , NIL otherwise

Definition at line 1125 of file SCOLObject.cpp.

SO3ObjectSetGlobalPosition()

int SO3ObjectSetGlobalPosition

(

mmachine

m

)

SO3ObjectSetGlobalPosition : Set Global Object Postion.

Prototype: fun [SO3_OBJECT [F F F]] I

Parameters

SO3_OBJECT	: current node
[F	F F] : position (3d vector)

Returns

I : 1 if success , NIL otherwise

Definition at line 1076 of file SCOLObject.cpp.

SO3ObjectSetGlobalScale()

int SO3ObjectSetGlobalScale

(

mmachine

m

)

SO3ObjectSetGlobalScale : Set Global Object scale.

Prototype: fun [SO3_OBJECT [F F F]] I

Parameters

SO3_OBJECT	: current node
[F	F F] : scale (3d vector)

Returns

I : 1 if success , NIL otherwise

Definition at line 1177 of file SCOLObject.cpp.

SO3ObjectSetInheritOrientation()

int SO3ObjectSetInheritOrientation

(

mmachine

m

)

SO3ObjectSetInheritOrientation : Set the inherit orientation of a node.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current node
I	: state, 1 to enable, 0 to disable inherit orientation

Returns

I : 1 if success, NIL otherwise

Definition at line 4032 of file SCOLObject.cpp.

SO3ObjectSetInitialState()

int SO3ObjectSetInitialState

(

mmachine

m

)

SO3ObjectSetInitialState : defines initial state of a node.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: current node

Returns

I : 1 if success , NIL otherwise

Definition at line 1935 of file SCOLObject.cpp.

SO3ObjectSetMouseClick()

int SO3ObjectSetMouseClick

(

mmachine

m

)

SO3ObjectSetMouseClick : defines mouse click state of a node.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current node
I	: mouse click state (1 enable, 0 disable)

Returns

I : 1 if success , NIL otherwise

Definition at line 3099 of file SCOLObject.cpp.

SO3ObjectSetMouseForeGround()

int SO3ObjectSetMouseForeGround

(

mmachine

m

)

SO3ObjectSetMouseForeGround : defines mouse foreground priority of a node.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current node
I	: Foreground priority (1 enable, 0 disable)

Returns

I : 1 if success , NIL otherwise

Definition at line 3051 of file SCOLObject.cpp.

SO3ObjectSetOrientation()

int SO3ObjectSetOrientation

(

mmachine

m

)

SO3ObjectSetOrientation : Set an orientation for a given node.

Prototype: fun [SO3_OBJECT [F F F F]] I

Parameters

SO3_OBJECT	: current node
[F	F F F] : orientation (quaternion)

Returns

I : 1 if success , NIL otherwise

Definition at line 629 of file SCOLObject.cpp.

SO3ObjectSetPosition()

int SO3ObjectSetPosition

(

mmachine

m

)

SO3ObjectSetPosition : defines position for a given node.

Prototype: fun [SO3_OBJECT [F F F]] I

Parameters

SO3_OBJECT	: current node
[F	F F] : Position vector

Returns

I : 1 if success , NIL otherwise

Definition at line 769 of file SCOLObject.cpp.

SO3ObjectSetRenderingDistance()

int SO3ObjectSetRenderingDistance

(

mmachine

m

)

SO3ObjectSetRenderingDistance : defines a maximum distance for rendering the object.

Prototype: fun [SO3_OBJECT F] I

Parameters

SO3_OBJECT	: current node
F	: distance value, 0 for default (infinit)

Returns

I : 1 if success , NIL otherwise

Definition at line 2519 of file SCOLObject.cpp.

SO3ObjectSetRenderOverlay()

int SO3ObjectSetRenderOverlay

(

mmachine

m

)

SO3ObjectSetRenderOverlay : defines render overlay priority of a mesh.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current node
I	: 1 to enable 0 to disable overlay priority

Returns

I : 1 if success , NIL otherwise

Definition at line 3309 of file SCOLObject.cpp.

SO3ObjectSetRenderQueue()

int SO3ObjectSetRenderQueue

(

mmachine

m

)

SO3ObjectSetRenderQueue : defines render queue position of a mesh.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current node
I	: render queue position, NIL for default

Returns

I : 1 if success , NIL otherwise

Definition at line 3358 of file SCOLObject.cpp.

SO3ObjectSetScale()

int SO3ObjectSetScale

(

mmachine

m

)

SO3ObjectSetScale : Scale a given node.

Prototype: fun [SO3_OBJECT [F F F]] I

Parameters

SO3_OBJECT	: current node
[F	F F] : Scale vector

Returns

I : 1 if success , NIL otherwise

Definition at line 884 of file SCOLObject.cpp.

SO3ObjectSetVisible()

int SO3ObjectSetVisible

(

mmachine

m

)

SO3ObjectSetVisible : defines visible state of a node.

Prototype: fun [SO3_OBJECT I I] I

Parameters

SO3_OBJECT	: current node
I	: boolean (1 visible, 0 not)
I	: recursive (1 set visible recursivly, 0 only this node).

Returns

I : 1 if success , NIL otherwise

Definition at line 496 of file SCOLObject.cpp.

SO3ObjectShowBoundingBox()

int SO3ObjectShowBoundingBox

(

mmachine

m

)

SO3ObjectShowBoundingBox : Allow the display of BoundingBox.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current node
I	: boolean (1 enable, 0 disable)

Returns

I : 1 if success , NIL otherwise

Definition at line 119 of file SCOLObject.cpp.

SO3ObjectTranslate()

int SO3ObjectTranslate

(

mmachine

m

)

SO3ObjectTranslate : Translate a given node.

Prototype: fun [SO3_OBJECT [F F F] I] I

Parameters

SO3_OBJECT	: current node
[F	F F] : Position vector
I	: Transform space

For transform space, values are :

• SO3_LOCAL_TS
• SO3_PARENT_TS
• SO3_WORLD_TS

Returns

I : 1 if success , NIL otherwise

Definition at line 823 of file SCOLObject.cpp.

SO3ObjectUnlink()

int SO3ObjectUnlink

(

mmachine

m

)

SO3ObjectUnlink : Unlink a node from the scene.

Prototype:fun [SO3_OBJECT] I

Parameters

SO3_OBJECT

: child node

Returns

I : 1 if success , NIL otherwise

Definition at line 2365 of file SCOLObject.cpp.