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	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	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	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	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	SO3ObjectSetRenderOverlay (mmachine m)
	SO3ObjectSetRenderOverlay : defines render overlay priority of a node.
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.

---

Detailed Description

Scol functions definition

---

Function Documentation

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 487 of file SCOLObject.cpp.

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 1715 of file SCOLObject.cpp.

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 3393 of file SCOLObject.cpp.

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 2434 of file SCOLObject.cpp.

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 2550 of file SCOLObject.cpp.

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 1650 of file SCOLObject.cpp.

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 836 of file SCOLObject.cpp.

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 1128 of file SCOLObject.cpp.

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 1393 of file SCOLObject.cpp.

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 2888 of file SCOLObject.cpp.

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 2958 of file SCOLObject.cpp.

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 788 of file SCOLObject.cpp.

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 1081 of file SCOLObject.cpp.

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 1222 of file SCOLObject.cpp.

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 1269 of file SCOLObject.cpp.

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 2787 of file SCOLObject.cpp.

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 2741 of file SCOLObject.cpp.

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 402 of file SCOLObject.cpp.

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 3270 of file SCOLObject.cpp.

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 740 of file SCOLObject.cpp.

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 2018 of file SCOLObject.cpp.

int SO3ObjectGetParent

(

mmachine

m

)

SO3ObjectGetParent : Get the parent node of a node.

Prototype: fun [SO3_OBJECT] I

Parameters:

SO3_OBJECT

: current node

Returns:

SO3_OBJECT : Parent if success , NIL otherwise

Definition at line 1860 of file SCOLObject.cpp.

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 2602 of file SCOLObject.cpp.

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 1034 of file SCOLObject.cpp.

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 1967 of file SCOLObject.cpp.

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 2326 of file SCOLObject.cpp.

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 1175 of file SCOLObject.cpp.

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 2070 of file SCOLObject.cpp.

int SO3ObjectGetSceneRoot

(

mmachine

m

)

SO3ObjectGetSceneRoot : Get the scene root node.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

SO3_OBJECT : Scene root node if success , NIL otherwise

Definition at line 1821 of file SCOLObject.cpp.

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 3110 of file SCOLObject.cpp.

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 3187 of file SCOLObject.cpp.

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 356 of file SCOLObject.cpp.

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 1333 of file SCOLObject.cpp.

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 1908 of file SCOLObject.cpp.

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 243 of file SCOLObject.cpp.

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 1577 of file SCOLObject.cpp.

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 1614 of file SCOLObject.cpp.

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 537 of file SCOLObject.cpp.

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 1783 of file SCOLObject.cpp.

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 72 of file SCOLObject.cpp.

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 1538 of file SCOLObject.cpp.

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 1447 of file SCOLObject.cpp.

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 1492 of file SCOLObject.cpp.

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 2161 of file SCOLObject.cpp.

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 2377 of file SCOLObject.cpp.

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 178 of file SCOLObject.cpp.

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 934 of file SCOLObject.cpp.

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 885 of file SCOLObject.cpp.

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 986 of file SCOLObject.cpp.

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 1744 of file SCOLObject.cpp.

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 2694 of file SCOLObject.cpp.

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 2646 of file SCOLObject.cpp.

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 435 of file SCOLObject.cpp.

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 575 of file SCOLObject.cpp.

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 2274 of file SCOLObject.cpp.

int SO3ObjectSetRenderOverlay

(

mmachine

m

)

SO3ObjectSetRenderOverlay : defines render overlay priority of a node.

Prototype: fun [SO3_OBJECT I] I

Parameters:

	SO3_OBJECT	: current node
	I	: render overlay priority

Returns:

I : 1 if success , NIL otherwise

Definition at line 2834 of file SCOLObject.cpp.

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 691 of file SCOLObject.cpp.

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 302 of file SCOLObject.cpp.

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 124 of file SCOLObject.cpp.

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 632 of file SCOLObject.cpp.

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 2120 of file SCOLObject.cpp.