Scene

Functions
int	SO3CbMaterialCollision (mmachine m)
	SO3CbMaterialCollision : Define the callback scol had to be called when two material ID collide.
int	SO3CbMaterialOverlapStarted (mmachine m)
	SO3CbMaterialOverlapStarted : Define the callback scol had to be called when two material ID start to overlap.
int	SO3CbMaterialOverlapEnded (mmachine m)
	SO3CbMaterialOverlapEnded : Define the callback scol had to be called when two material ID does not overlap together anymore.
int	SO3CbBodyLeaveWorld (mmachine m)
	SO3CbBodyLeaveWorld : Define the scol callback had to be called when a body leave the physic world.
int	SO3SceneLoadEntity (mmachine m)
	SO3SceneLoadEntity : create an Entity as a new SO3_Object.
int	SO3SceneUnloadResource (mmachine m)
	SO3SceneUnloadResource : Unload a resource from Scene TODO!
int	SO3SceneLoadResource (mmachine m)
	SO3SceneLoadResource : Load a resource in Scene.
int	SO3SceneCloneAnimation (mmachine m)
	SO3SceneCloneAnimation : Clone a SO3_ANIM in Scene.
int	SO3SceneCloneAnimTrack (mmachine m)
	SO3SceneCloneAnimTrack : Clone a SO3_ANIMTRACK in Scene on a given SO3_ANIM DEPRECATED FUNCTION Prototype: fun [SO3_SCENE SO3_OBJECT SO3_ANIM I] SO3_ANIMTRACK.
int	SO3SceneLoadResourceMaterial (mmachine m)
	SO3SceneLoadResourceMaterial :Load Resource Material in Scene Deprecated
int	SO3SceneCreate (mmachine m)
	SO3SceneCreate : Create a new scene.
int	SO3SceneDelete (mmachine m)
	SO3SceneDelete : destroy a scene.
int	SO3SceneClear (mmachine m)
	SO3SceneClear : clear a scene.
int	SO3WorldSetFPS (mmachine m)
	SO3WorldSetFPS : defines FPS for physic world.
int	SO3WorldSetSize (mmachine m)
	SO3WorldSetSize : function to defines world size.
int	SO3SceneSetSkyBox (mmachine m)
	SO3SceneSetSkyBox : function to set a sky box for a scene.
int	SO3SceneSetSkyBoxEnable (mmachine m)
	SO3SceneSetSkyBox : function to defines visiblity state for a sky box.
int	SO3SceneGetSkyBoxParameters (mmachine m)
	SO3SceneGetSkyBoxParameters : function to get the sky box parameters.
int	SO3SceneSetSkyDome (mmachine m)
	SO3SceneSetSkyDome : function to set a sky dome for a scene.
int	SO3SceneSetSkyDomeEnable (mmachine m)
	SO3SceneSetSkyDomeEnable : function to defines visiblity state for a sky dome.
int	SO3SceneGetSkyDomeParameters (mmachine m)
	SO3SceneGetSkyDomeParameters : function to get the sky dome parameters.
int	SO3SceneSetSkyPlane (mmachine m)
	SO3SceneSetSkyPlane : function to set a sky plane for a scene.
int	SO3SceneSetSkyPlaneEnable (mmachine m)
	SO3SceneSetSkyPlaneEnable : function to defines visiblity state for a sky plane.
int	SO3SceneGetSkyPlaneParameters (mmachine m)
	SO3SceneGetSkyPlaneParameters : function to get the sky plane parameters.
int	SO3SceneSetAmbientLight (mmachine m)
	SO3SceneSetAmbientLight : function to defines ambient light of the scene.
int	SO3SceneGetAmbientLight (mmachine m)
	SO3SceneGetAmbientLight : function to get the ambient light of the scene.
int	SO3SceneGetFogColor (mmachine m)
	SO3SceneGetFogColor : function to get the fog color of the scene.
int	SO3SceneGetFogMode (mmachine m)
	SO3SceneGetFogColor : function to get the fog mode of the scene.
int	SO3SceneGetFogDensity (mmachine m)
	SO3SceneGetFogDensity : function to get the fog density of the scene.
int	SO3SceneGetFogStart (mmachine m)
	SO3SceneGetFogStart : function to get the fog start of the scene.
int	SO3SceneGetFogEnd (mmachine m)
	SO3SceneGetFogEnd : function to get the fog end of the scene.
int	SO3SceneSetFog (mmachine m)
	SO3SceneSetFog : function to defines fog properties of the scene.
int	SO3SceneSetShadowColor (mmachine m)
	SO3SceneSetShadowColor : function to defines shadow color of the scene.
int	SO3SceneGetShadowColor (mmachine m)
	SO3SceneGetShadowColor : function to get the shadow color of the scene.
int	SO3SceneSetSelfShadowTexture (mmachine m)
	SO3SceneSetSelfShadowTexture : function to defines self shadow texture of the scene.
int	SO3SceneSetShadowTextureCount (mmachine m)
	SO3SceneSetShadowTextureCount : function to defines shadow texture count in the scene.
int	SO3SceneSetShadowTextureSize (mmachine m)
	SO3SceneSetShadowTextureSize : function to defines shadow texture size of the scene.
int	SO3SceneSetDefaultShadowCamera (mmachine m)
	SO3SceneSetDefaultShadowCamera : function to defines default shadow camera.
int	SO3SceneSetFocusedShadowCamera (mmachine m)
	SO3SceneSetFocusedShadowCamera : function to set focused shadow camera.
int	SO3SceneSetLISPSMShadowCamera (mmachine m)
	SO3SceneSetLISPSMShadowCamera : function to set LISPSM shadow camera.
int	SO3SceneSetPlaneShadowCamera (mmachine m)
	SO3SceneSetPlaneShadowCamera : function to set Plane shadow camera.
int	SO3SceneSetShadowDirectionalLightExtrusionDistance (mmachine m)
	SO3SceneSetShadowDirectionalLightExtrusionDistance : function to defines shadow directional light extrusion distance.
int	SO3SceneSetShadowFarDistance (mmachine m)
	SO3SceneSetShadowFarDistance : function to defines distance maximum for shadows.
int	SO3SceneSetShadowTextureFadeStart (mmachine m)
	SO3SceneSetShadowTextureFadeStart : function to defines fade start distance for shadows.
int	SO3SceneGetShadowTechnique (mmachine m)
	SO3SceneGetShadowTechnique : function to defines technique for shadows.
int	SO3SceneSetShadowTextureFadeEnd (mmachine m)
	SO3SceneSetShadowTextureFadeEnd : function to defines texture fade end for textured shaodw technique.
int	SO3SceneSetShadowDirLightTextureOffset (mmachine m)
	SO3SceneSetShadowDirLightTextureOffset : function to defines texture offset.
int	SO3SceneGetSelfShadowTexture (mmachine m)
	SO3SceneGetSelfShadowTexture : function to get the self shadow texture.
int	SO3SceneGetShadowCameraSetup (mmachine m)
	SO3SceneGetShadowCameraSetup : function to get the shadow camera setup mode.
int	SO3SceneGetShadowDirectionalLightExtrusionDistance (mmachine m)
	SO3SceneGetShadowDirectionalLightExtrusionDistance : function to get the shadows direction light extrusion distance.
int	SO3SceneGetShadowFarDistance (mmachine m)
	SO3SceneGetShadowFarDistance : function to get the shadows far distance.
int	SO3SceneGetShadowDirLightTextureOffset (mmachine m)
	SO3SceneGetShadowDirLightTextureOffset : function to get the shadows direction light texture offset.
int	SO3SceneGetShadowTextureCount (mmachine m)
	SO3SceneGetShadowTextureCount : function to get the shadows texture count.
int	SO3SceneSetShadowTechnique (mmachine m)
	SO3SceneSetShadowTechnique : function to get the shadows technique.
int	SO3SceneSetShadowCaster (mmachine m)
	SO3SceneSetShadowCaster : function to defines shadows caster.
int	SO3SceneSetShadowReceiver (mmachine m)
	SO3SceneSetShadowReceiver : function to defines shadows receiver.
int	SO3SceneGetShadowCaster (mmachine m)
	SO3SceneGetShadowCaster : function to retrieve shadows caster material name.
int	SO3SceneGetShadowReceiver (mmachine m)
	SO3SceneGetShadowReceiver : function to retrieve shadows receiver.
int	SO3SceneGetNode (mmachine m)
	SO3SceneGetNode : return a scene node by its name.
int	SO3SceneGetObject (mmachine m)
	SO3SceneGetObject : return a scene object by its name.
int	SO3SceneNodeCreate (mmachine m)
	SO3SceneNodeCreate : Create a new node.
int	SO3SceneParseMaterialsFromGroup (mmachine m)
	SO3SceneParseMaterialsFromGroup : Return the list of materials from a group name.
int	SO3SceneParseNotLoadedMaterialsFromGroup (mmachine m)
	SO3SceneParseNotLoadedMaterialsFromGroup : Return the list of materials not already in use from a group name.
int	SO3SceneParseCompositorsFromGroup (mmachine m)
	SO3SceneParseCompositorsFromGroup : Return the list of compositors from a group name.
int	SO3SceneParseSchemeFromGroup (mmachine m)
	SO3SceneParseSchemeFromGroup : Return the list of material scheme from a group name.
int	SO3SceneParseParticleSystemsFromGroup (mmachine m)
	SO3SceneParseParticleSystemsFromGroup : Return the list of particle systems from a group name.
int	SO3SceneGetMaterial (mmachine m)
	SO3SceneGetMaterial : Return a material by its name.
int	SO3SceneGetTexture (mmachine m)
	SO3SceneGetTexture : Return a texture by its name.
int	SO3PlaneCreate (mmachine m)
	SO3PlaneCreate : create a plane as a SO3_OBJECT.
int	SO3SceneGetAnimation (mmachine m)
	SO3SceneGetAnimation : return an animation by its name.
int	SO3SceneGetAnimations (mmachine m)
	SO3SceneGetAnimations : Return the list of animations on a scene.
int	SO3SceneGetNumAnimations (mmachine m)
	SO3SceneGetNumAnimations : return an animation by its name.
int	SO3CbScenePreRender (mmachine m)
	SO3CbScenePreRender : defines callback for pre render event.
int	SO3CbScenePostRender (mmachine m)
	SO3CbScenePostRender : defines callback for post render event.
int	SO3BufferGetLastMouseInfos (mmachine m)
	SO3BufferGetLastMouseInfos : get Last raycast info of a given render window.

---

Detailed Description

Scol functions definition

---

Function Documentation

int SO3BufferGetLastMouseInfos

(

mmachine

m

)

SO3BufferGetLastMouseInfos : get Last raycast info of a given render window.

Prototype: fun [SO3_BUFFER] [SO3_SCENE SO3_OBJECT SO3_MATERIAL I [I [[F F F] [F F F] [F F F]] [[F F] [F F] [F F]]] [F F F] [F F] F]

Parameters:

SO3_BUFFER

: targeted render window

Returns:

[SO3_SCENE SO3_VIEWPORT SO3_OBJECT SO3_MATERIAL I [I [[F F F] [F F F] [F F F]] [[F F] [F F] [F F]]] [F F F] [F F] F] : Raycast Informations if success, NIL otherwise

• Scene founded
• Collided Object
• Collided Material
• subEntity index -- face index --- vertex1 coordinates --- vertex2 coordinates --- vertex3 coordinates -- uv1 coordinates -- uv2 coordinates -- uv3 coordinates
• collision point coordinates
• uv coordinates of the collision point
• Distance

Definition at line 2321 of file SO3SCOL.cpp.

int SO3CbBodyLeaveWorld

(

mmachine

m

)

SO3CbBodyLeaveWorld : Define the scol callback had to be called when a body leave the physic world.

Prototype: fun [SO3_SCENE fun [SO3_PHYSICBODY u0] u1 u0] SO3_PHYSICBODY

Parameters:

	SO3_PHYSICBODY	: physic body
	fun	[SO3_PHYSICBODY u0] u1 : function scol to call SO3_PHYSICBODY : the body who leaves u0 : user param
	u0	: user parameter

Returns:

I : 1, NIL otherwise

Definition at line 4621 of file SCOLPhysics.cpp.

int SO3CbMaterialCollision

(

mmachine

m

)

SO3CbMaterialCollision : Define the callback scol had to be called when two material ID collide.

Prototype: fun [SO3_PHYSICMATERIAL SO3_PHYSICMATERIAL fun [SO3_SCENE u0 SO3_PHYSICBODY SO3_PHYSICBODY [F F F] [F F F] F F] u1 u0 ] SO3_PHYSICMATERIALPAIR

Parameters:

	SO3_PHYSICMATERIAL	: current Material ID1
	SO3_PHYSICMATERIAL	: current Material ID2
	fun	[SO3_SCENE u0 SO3_PHYSICBODY SO3_PHYSICBODY [F F F] [F F F] [F F F] F] u1 : function scol to call SO3_SCENE : current scene SO3_PHYSICBODY : current first body that collides SO3_PHYSICBODY : current second body that collides [F F F] : collision position [F F F] : collision normal F : collision normal speed F : collision force
	u0	: user parameter

Returns:

I : 1, NIL otherwise

Definition at line 4320 of file SCOLPhysics.cpp.

int SO3CbMaterialOverlapEnded

(

mmachine

m

)

SO3CbMaterialOverlapEnded : Define the callback scol had to be called when two material ID does not overlap together anymore.

Prototype: fun [SO3_PHYSICMATERIAL SO3_PHYSICMATERIAL fun [SO3_SCENE u0 SO3_PHYSICBODY SO3_PHYSICBODY] u1 u0 ] SO3_PHYSICMATERIALPAIR

Parameters:

	SO3_PHYSICMATERIAL	: current Material ID1
	SO3_PHYSICMATERIAL	: current Material ID2
	fun	[SO3_SCENE u0 SO3_PHYSICBODY SO3_PHYSICBODY] u1 : function scol to call SO3_SCENE : current scene SO3_PHYSICBODY : current first body that do not collide anymore SO3_PHYSICBODY : current second body that do not collide anymore
	u0	: user parameter

Returns:

I : 1, NIL otherwise

Definition at line 4522 of file SCOLPhysics.cpp.

int SO3CbMaterialOverlapStarted

(

mmachine

m

)

SO3CbMaterialOverlapStarted : Define the callback scol had to be called when two material ID start to overlap.

Prototype: fun [SO3_PHYSICMATERIAL SO3_PHYSICMATERIAL fun [SO3_SCENE u0 SO3_PHYSICBODY SO3_PHYSICBODY] u1 u0 ] SO3_PHYSICMATERIALPAIR

Parameters:

	SO3_PHYSICMATERIAL	: current Material ID1
	SO3_PHYSICMATERIAL	: current Material ID2
	fun	[SO3_SCENE u0 SO3_PHYSICBODY SO3_PHYSICBODY] u1 : function scol to call SO3_SCENE : current scene SO3_PHYSICBODY : current first body that collides SO3_PHYSICBODY : current second body that collides
	u0	: user parameter

Returns:

I : 1, NIL otherwise

Definition at line 4421 of file SCOLPhysics.cpp.

int SO3CbScenePostRender

(

mmachine

m

)

SO3CbScenePostRender : defines callback for post render event.

Prototype: fun [SO3_SCENE fun [SO3_SCENE u0 I] u1 u0] SO3_SCENE

Parameters:

	SO3_SCENE	: scene object
	fun	[SO3_SCENE u0 I] u1 : function scol to call
	u0	: user parameter
	I	: time elapsed since last frame in millisecond

Returns:

SO3_SCENE : same scene object if success

Definition at line 4247 of file SCOLScene.cpp.

int SO3CbScenePreRender

(

mmachine

m

)

SO3CbScenePreRender : defines callback for pre render event.

Prototype: fun [SO3_SCENE fun [SO3_SCENE u0 I] u1 u0] SO3_SCENE

Parameters:

	SO3_SCENE	: scene object
	fun	[SO3_SCENE u0 I] u1 : function scol to call
	u0	: user parameter
	I	: time elapsed since last frame in millisecond

Returns:

SO3_SCENE : same scene object if success

Definition at line 4222 of file SCOLScene.cpp.

int SO3PlaneCreate

(

mmachine

m

)

SO3PlaneCreate : create a plane as a SO3_OBJECT.

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

Parameters:

	SO3_SCENE	: current scene
	S	: group name
	S	: plane name
	[F	F] : width and height
	[I	I] : plane segmentation X and Y (1 default)
	[F	F] : UV tile (U and V, 1.0 default)

Returns:

SO3_OBJECT : Plane created if success, NIL otherwise

Definition at line 4005 of file SCOLScene.cpp.

int SO3SceneClear

(

mmachine

m

)

SO3SceneClear : clear a scene.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : 1 if success, NIL otherwise

Definition at line 770 of file SCOLScene.cpp.

int SO3SceneCloneAnimation

(

mmachine

m

)

SO3SceneCloneAnimation : Clone a SO3_ANIM in Scene.

Prototype: fun [SO3_SCENE SO3_ANIM S] SO3_ANIM

Parameters:

	SO3_SCENE	: current scene
	SO3_ANIM	: initial animation which will be cloned
	S	: cloned animation name

Returns:

SO3_ANIM : The animation created if success, NIL otherwise

Definition at line 470 of file SCOLScene.cpp.

int SO3SceneCloneAnimTrack

(

mmachine

m

)

SO3SceneCloneAnimTrack : Clone a SO3_ANIMTRACK in Scene on a given SO3_ANIM DEPRECATED FUNCTION Prototype: fun [SO3_SCENE SO3_OBJECT SO3_ANIM I] SO3_ANIMTRACK.

Parameters:

	SO3_SCENE	: current scene
	SO3_OBJECT	: Associated node
	SO3_ANIM	: Associated animation
	I	: Animation track type

Returns:

SO3_ANIMTRACK : The animation track cloned if success, NIL otherwise

Definition at line 539 of file SCOLScene.cpp.

int SO3SceneCreate

(

mmachine

m

)

SO3SceneCreate : Create a new scene.

Prototype: fun [Chn S] SO3_SCENE

Parameters:

	Chn	: current channel
	S	: given name for the scene

Returns:

SO3_SCENE : the created scene if success, NIL otherwise

Definition at line 680 of file SCOLScene.cpp.

int SO3SceneDelete

(

mmachine

m

)

SO3SceneDelete : destroy a scene.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : 1 if success, NIL otherwise

Definition at line 742 of file SCOLScene.cpp.

int SO3SceneGetAmbientLight

(

mmachine

m

)

SO3SceneGetAmbientLight : function to get the ambient light of the scene.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : color (rgba) if success, NIL otherwise

Definition at line 1996 of file SCOLScene.cpp.

int SO3SceneGetAnimation

(

mmachine

m

)

SO3SceneGetAnimation : return an animation by its name.

Prototype: fun [SO3_SCENE S] SO3_ANIM

Parameters:

	SO3_SCENE	: current scene
	S	: given name

Returns:

SO3_ANIM : animation if success, NIL otherwise

Definition at line 4080 of file SCOLScene.cpp.

int SO3SceneGetAnimations

(

mmachine

m

)

SO3SceneGetAnimations : Return the list of animations on a scene.

Prototype: fun [SO3_SCENE] [SO3_ANIM r1]

Parameters:

SO3_SCENE

: current scene

Returns:

[SO3_ANIM r1] : list animations if success , NIL otherwise

Definition at line 4126 of file SCOLScene.cpp.

int SO3SceneGetFogColor

(

mmachine

m

)

SO3SceneGetFogColor : function to get the fog color of the scene.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : color (rgba) if success, NIL otherwise

Definition at line 2035 of file SCOLScene.cpp.

int SO3SceneGetFogDensity

(

mmachine

m

)

SO3SceneGetFogDensity : function to get the fog density of the scene.

Prototype: fun [SO3_SCENE] F

Parameters:

SO3_SCENE

: current scene

Returns:

F : fog density if success, NIL otherwise

Definition at line 2114 of file SCOLScene.cpp.

int SO3SceneGetFogEnd

(

mmachine

m

)

SO3SceneGetFogEnd : function to get the fog end of the scene.

Prototype: fun [SO3_SCENE] F

Parameters:

SO3_SCENE

: current scene

Returns:

F : fog end if success, NIL otherwise

Definition at line 2182 of file SCOLScene.cpp.

int SO3SceneGetFogMode

(

mmachine

m

)

SO3SceneGetFogColor : function to get the fog mode of the scene.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : fog mode if success, NIL otherwise

For fog mode, values are :

• SO3_FOG_NONE
• SO3_FOG_EXP
• SO3_FOG_EXP2
• SO3_FOG_LINEAR

Definition at line 2080 of file SCOLScene.cpp.

int SO3SceneGetFogStart

(

mmachine

m

)

SO3SceneGetFogStart : function to get the fog start of the scene.

Prototype: fun [SO3_SCENE] F

Parameters:

SO3_SCENE

: current scene

Returns:

F : fog start if success, NIL otherwise

Definition at line 2148 of file SCOLScene.cpp.

int SO3SceneGetMaterial

(

mmachine

m

)

SO3SceneGetMaterial : Return a material by its name.

Prototype: fun [SO3_SCENE S S] SO3_MATERIAL

Parameters:

	SO3_SCENE	: current scene
	S	: given group name
	S	: given material name

Returns:

SO3_MATERIAL : material if success, NIL otherwise

Definition at line 3884 of file SCOLScene.cpp.

int SO3SceneGetNode

(

mmachine

m

)

SO3SceneGetNode : return a scene node by its name.

Prototype: fun [SO3_SCENE S] SO3_OBJECT

Parameters:

	SO3_SCENE	: current scene
	S	: given name

Returns:

SO3_OBJECT : node if success, NIL otherwise

Definition at line 3368 of file SCOLScene.cpp.

int SO3SceneGetNumAnimations

(

mmachine

m

)

SO3SceneGetNumAnimations : return an animation by its name.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

SO3_ANIM : number of animations if success, NIL otherwise

Definition at line 4187 of file SCOLScene.cpp.

int SO3SceneGetObject

(

mmachine

m

)

SO3SceneGetObject : return a scene object by its name.

Prototype: fun [SO3_SCENE S] SO3_OBJECT

Parameters:

	SO3_SCENE	: current scene
	S	: given name

Returns:

SO3_OBJECT : object if success, NIL otherwise

Definition at line 3412 of file SCOLScene.cpp.

int SO3SceneGetSelfShadowTexture

(

mmachine

m

)

SO3SceneGetSelfShadowTexture : function to get the self shadow texture.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : 1 enable/0 disable if success, NIL otherwise

Definition at line 2919 of file SCOLScene.cpp.

int SO3SceneGetShadowCameraSetup

(

mmachine

m

)

SO3SceneGetShadowCameraSetup : function to get the shadow camera setup mode.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : shadow camera setup mode if success, NIL otherwise

Definition at line 2953 of file SCOLScene.cpp.

int SO3SceneGetShadowCaster

(

mmachine

m

)

SO3SceneGetShadowCaster : function to retrieve shadows caster material name.

Prototype: fun [SO3_SCENE] S

Parameters:

SO3_SCENE

: current scene

Returns:

I : name for shadow caster material if success, NIL otherwise

Definition at line 3284 of file SCOLScene.cpp.

int SO3SceneGetShadowColor

(

mmachine

m

)

SO3SceneGetShadowColor : function to get the shadow color of the scene.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : color (rgba) if success, NIL otherwise

Definition at line 2319 of file SCOLScene.cpp.

int SO3SceneGetShadowDirectionalLightExtrusionDistance

(

mmachine

m

)

SO3SceneGetShadowDirectionalLightExtrusionDistance : function to get the shadows direction light extrusion distance.

Prototype: fun [SO3_SCENE] F

Parameters:

SO3_SCENE

: current scene

Returns:

F : distance if success, NIL otherwise

Definition at line 2985 of file SCOLScene.cpp.

int SO3SceneGetShadowDirLightTextureOffset

(

mmachine

m

)

SO3SceneGetShadowDirLightTextureOffset : function to get the shadows direction light texture offset.

Prototype: fun [SO3_SCENE] F

Parameters:

SO3_SCENE

: current scene

Returns:

F : offset if success, NIL otherwise

Definition at line 3051 of file SCOLScene.cpp.

int SO3SceneGetShadowFarDistance

(

mmachine

m

)

SO3SceneGetShadowFarDistance : function to get the shadows far distance.

Prototype: fun [SO3_SCENE] F

Parameters:

SO3_SCENE

: current scene

Returns:

F : distance if success, NIL otherwise

Definition at line 3018 of file SCOLScene.cpp.

int SO3SceneGetShadowReceiver

(

mmachine

m

)

SO3SceneGetShadowReceiver : function to retrieve shadows receiver.

Prototype: fun [SO3_SCENE] S

Parameters:

SO3_SCENE

: current scene

Returns:

S : name for shadow receiver material if success, NIL otherwise

Definition at line 3325 of file SCOLScene.cpp.

int SO3SceneGetShadowTechnique

(

mmachine

m

)

SO3SceneGetShadowTechnique : function to defines technique for shadows.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : shadow technique if success, NIL otherwise

For shadow techniques, values are :

• SO3_SHADOWTYPE_NONE
• SO3_SHADOWDETAILTYPE_ADDITIVE
• SO3_SHADOWDETAILTYPE_MODULATIVE
• SO3_SHADOWDETAILTYPE_INTEGRATED
• SO3_SHADOWDETAILTYPE_STENCIL
• SO3_SHADOWDETAILTYPE_TEXTURE
• SO3_SHADOWTYPE_STENCIL_MODULATIVE
• SO3_SHADOWTYPE_STENCIL_ADDITIVE
• SO3_SHADOWTYPE_TEXTURE_MODULATIVE
• SO3_SHADOWTYPE_TEXTURE_ADDITIVE
• SO3_SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED
• SO3_SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED

Definition at line 2795 of file SCOLScene.cpp.

int SO3SceneGetShadowTextureCount

(

mmachine

m

)

SO3SceneGetShadowTextureCount : function to get the shadows texture count.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : texture count if success, NIL otherwise

Definition at line 3084 of file SCOLScene.cpp.

int SO3SceneGetSkyBoxParameters

(

mmachine

m

)

SO3SceneGetSkyBoxParameters : function to get the sky box parameters.

Prototype: fun [SO3_SCENE] [SO3_MATERIAL F [F F F F] I I]

Parameters:

SO3_SCENE

: current scene

Returns:

[SO3_MATERIAL F [F F F F] I I] : SkyBox parameters if success, NIL otherwise

• SO3_MATERIAL : Sky Box Material
• F : Sky Box distance
• [F F F F] : Sky Box orientation (quaternion)
• I : bool visible
• I : bool draw first

Definition at line 1202 of file SCOLScene.cpp.

int SO3SceneGetSkyDomeParameters

(

mmachine

m

)

SO3SceneGetSkyDomeParameters : function to get the sky dome parameters.

Prototype: fun [SO3_SCENE] [SO3_MATERIAL F F F I I I [F F F F] I I]

Parameters:

SO3_SCENE

: current scene

Returns:

[SO3_MATERIAL F F F I I I [F F F F] I I] : SkyDome parameters if success, NIL otherwise

• SO3_MATERIAL : Sky Dome Material
• F : Sky Dome curvature
• F : Sky Dome tiling
• F : Sky Dome distance
• I : Sky Dome xSeg
• I : Sky Dome ySeg
• I : Sky Dome yKeep
• [F F F F] : Sky Dome orientation (quaternion)
• I : bool visible
• I : bool draw first

Definition at line 1504 of file SCOLScene.cpp.

int SO3SceneGetSkyPlaneParameters

(

mmachine

m

)

SO3SceneGetSkyPlaneParameters : function to get the sky plane parameters.

Prototype: fun [SO3_SCENE] [SO3_MATERIAL F F F I I F [F F F] I I]

Parameters:

SO3_SCENE

: current scene

Returns:

[SO3_MATERIAL F F F I I F [F F F] I I] : SkyPlane parameters if success, NIL otherwise

• SO3_MATERIAL : Sky Plane Material
• F : Sky Plane bow
• F : Sky Plane scale
• F : Sky Plane tiling
• I : Sky Plane xSeg
• I : Sky Plane ySeg
• F : Sky Plane distance
• [F F F] : Sky Plane vector (quaternion)
• I : bool visible
• I : bool draw first

Definition at line 1837 of file SCOLScene.cpp.

int SO3SceneGetTexture

(

mmachine

m

)

SO3SceneGetTexture : Return a texture by its name.

Prototype: fun [SO3_SCENE S S] SO3_TEXTURE

Parameters:

	SO3_SCENE	: current scene
	S	: given group name
	S	: given material name

Returns:

SO3_TEXTURE : texture if success, NIL otherwise

Definition at line 3935 of file SCOLScene.cpp.

int SO3SceneLoadEntity

(

mmachine

m

)

SO3SceneLoadEntity : create an Entity as a new SO3_Object.

Prototype: fun [SO3_SCENE S S P] SO3_OBJECT

Parameters:

	SO3_SCENE	: current scene
	S	: group name
	S	: given name for entity
	P	: given mesh path

Returns:

SO3_OBJECT : Entity object created if success, NIL otherwise

Definition at line 78 of file SCOLScene.cpp.

int SO3SceneLoadResource

(

mmachine

m

)

SO3SceneLoadResource : Load a resource in Scene.

Prototype: fun [SO3_SCENE S P I] I

Parameters:

	SO3_SCENE	: current scene
	S	: name of group
	P	: name of the resource
	I	: resource type

For Resource type, values are :

• SO3_RESOURCE_MESH
• SO3_RESOURCE_MATERIAL
• SO3_RESOURCE_TEXTURE
• SO3_RESOURCE_SKELETON
• SO3_RESOURCE_GPUPROGRAM
• SO3_RESOURCE_HIGHLEVELGPUPROGRAM
• SO3_RESOURCE_PARTICLE_SYSTEM

Returns:

I : 1 if success, NIL otherwise

Definition at line 283 of file SCOLScene.cpp.

int SO3SceneLoadResourceMaterial

(

mmachine

m

)

SO3SceneLoadResourceMaterial :Load Resource Material in Scene
Deprecated

Prototype: fun [SO3_SCENE S P] I

Parameters:

	SO3_SCENE	: current scene
	S	: given resource group
	P	: resource path (relative to scol partition)

Returns:

I : 1 if success, NIL otherwise

Definition at line 568 of file SCOLScene.cpp.

int SO3SceneNodeCreate

(

mmachine

m

)

SO3SceneNodeCreate : Create a new node.

Prototype: fun [SO3_SCENE S] SO3_OBJECT

Parameters:

	SO3_SCENE	: current scene
	S	: given name

Returns:

SO3_OBJECT : Node created if success, NIL otherwise

Definition at line 3467 of file SCOLScene.cpp.

int SO3SceneParseCompositorsFromGroup

(

mmachine

m

)

SO3SceneParseCompositorsFromGroup : Return the list of compositors from a group name.

Prototype: fun [SO3_SCENE S] [S r1]

Parameters:

	SO3_SCENE	: current scene
	S	: given group name

Returns:

[S r1] : compositors list if success, NIL otherwise

Definition at line 3660 of file SCOLScene.cpp.

int SO3SceneParseMaterialsFromGroup

(

mmachine

m

)

SO3SceneParseMaterialsFromGroup : Return the list of materials from a group name.

Prototype: fun [SO3_SCENE S] [SO3_MATERIAL r1]

Parameters:

	SO3_SCENE	: current scene
	S	: given group name

Returns:

[SO3_MATERIAL r1] : materials list if success, NIL otherwise

Definition at line 3517 of file SCOLScene.cpp.

int SO3SceneParseNotLoadedMaterialsFromGroup

(

mmachine

m

)

SO3SceneParseNotLoadedMaterialsFromGroup : Return the list of materials not already in use from a group name.

Prototype: fun [SO3_SCENE S] [SO3_MATERIAL r1]

Parameters:

	SO3_SCENE	: current scene
	S	: given group name

Returns:

[SO3_MATERIAL r1] : materials list if success, NIL otherwise

Definition at line 3584 of file SCOLScene.cpp.

int SO3SceneParseParticleSystemsFromGroup

(

mmachine

m

)

SO3SceneParseParticleSystemsFromGroup : Return the list of particle systems from a group name.

Prototype: fun [SO3_SCENE S] [S r1]

Parameters:

	SO3_SCENE	: current scene
	S	: given group name

Returns:

[S r1] : particle systems list if success, NIL otherwise

Definition at line 3811 of file SCOLScene.cpp.

int SO3SceneParseSchemeFromGroup

(

mmachine

m

)

SO3SceneParseSchemeFromGroup : Return the list of material scheme from a group name.

Prototype: fun [SO3_SCENE S] [S r1]

Parameters:

	SO3_SCENE	: current scene
	S	: given group name

Returns:

[S r1] : material scheme list if success, NIL otherwise

Definition at line 3733 of file SCOLScene.cpp.

int SO3SceneSetAmbientLight

(

mmachine

m

)

SO3SceneSetAmbientLight : function to defines ambient light of the scene.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: given color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 1953 of file SCOLScene.cpp.

int SO3SceneSetDefaultShadowCamera

(

mmachine

m

)

SO3SceneSetDefaultShadowCamera : function to defines default shadow camera.

Prototype: fun [SO3_SCENE I] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : 1 if success, NIL otherwise

Definition at line 2486 of file SCOLScene.cpp.

int SO3SceneSetFocusedShadowCamera

(

mmachine

m

)

SO3SceneSetFocusedShadowCamera : function to set focused shadow camera.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : 1 if success, NIL otherwise

Definition at line 2532 of file SCOLScene.cpp.

int SO3SceneSetFog

(

mmachine

m

)

SO3SceneSetFog : function to defines fog properties of the scene.

Prototype: fun [SO3_SCENE I I F F F] I

Parameters:

	SO3_SCENE	: current scene
	I	: mode
	I	: color (rgba)
	F	: exponential coefficient
	F	: linear start
	F	: linear end

For fog mode, values are :

• SO3_FOG_NONE
• SO3_FOG_EXP
• SO3_FOG_EXP2
• SO3_FOG_LINEAR

Returns:

I : 1 if success, NIL otherwise

Definition at line 2227 of file SCOLScene.cpp.

int SO3SceneSetLISPSMShadowCamera

(

mmachine

m

)

SO3SceneSetLISPSMShadowCamera : function to set LISPSM shadow camera.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : 1 if success, NIL otherwise

Definition at line 2574 of file SCOLScene.cpp.

int SO3SceneSetPlaneShadowCamera

(

mmachine

m

)

SO3SceneSetPlaneShadowCamera : function to set Plane shadow camera.

Prototype: fun [SO3_SCENE [F F F] F] I

Parameters:

	SO3_SCENE	: current scene
	[F	F F] : vector which defines normal
	F	: distance

Returns:

I : 1 if success, NIL otherwise

Definition at line 2618 of file SCOLScene.cpp.

int SO3SceneSetSelfShadowTexture

(

mmachine

m

)

SO3SceneSetSelfShadowTexture : function to defines self shadow texture of the scene.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: boolean (1 enable/0 disable)

Returns:

I : 1 if success, NIL otherwise

Definition at line 2359 of file SCOLScene.cpp.

int SO3SceneSetShadowCaster

(

mmachine

m

)

SO3SceneSetShadowCaster : function to defines shadows caster.

Prototype: fun [SO3_SCENE S] I

Parameters:

	SO3_SCENE	: current scene
	S	: name for shadow caster material

Returns:

I : 1 if success, NIL otherwise

Definition at line 3188 of file SCOLScene.cpp.

int SO3SceneSetShadowColor

(

mmachine

m

)

SO3SceneSetShadowColor : function to defines shadow color of the scene.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: color (rgba)

Returns:

I : 1 if success, NIL otherwise

Definition at line 2276 of file SCOLScene.cpp.

int SO3SceneSetShadowDirectionalLightExtrusionDistance

(

mmachine

m

)

SO3SceneSetShadowDirectionalLightExtrusionDistance : function to defines shadow directional light extrusion distance.

Prototype: fun [SO3_SCENE F] I

Parameters:

	SO3_SCENE	: current scene
	F	: distance of extrusion light

Returns:

I : 1 if success, NIL otherwise

Definition at line 2680 of file SCOLScene.cpp.

int SO3SceneSetShadowDirLightTextureOffset

(

mmachine

m

)

SO3SceneSetShadowDirLightTextureOffset : function to defines texture offset.

Prototype: fun [SO3_SCENE F] I

Parameters:

	SO3_SCENE	: current scene
	F	: offset

Returns:

I : 1 if success, NIL otherwise

Definition at line 2886 of file SCOLScene.cpp.

int SO3SceneSetShadowFarDistance

(

mmachine

m

)

SO3SceneSetShadowFarDistance : function to defines distance maximum for shadows.

Prototype: fun [SO3_SCENE F] I

Parameters:

	SO3_SCENE	: current scene
	F	: distance

Returns:

I : 1 if success, NIL otherwise

Definition at line 2714 of file SCOLScene.cpp.

int SO3SceneSetShadowReceiver

(

mmachine

m

)

SO3SceneSetShadowReceiver : function to defines shadows receiver.

Prototype: fun [SO3_SCENE S] I

Parameters:

	SO3_SCENE	: current scene
	S	: name for shadow receiver material

Returns:

I : 1 if success, NIL otherwise

Definition at line 3236 of file SCOLScene.cpp.

int SO3SceneSetShadowTechnique

(

mmachine

m

)

SO3SceneSetShadowTechnique : function to get the shadows technique.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: shadow technique

For shadow techniques, values are :

• SO3_SHADOWTYPE_NONE
• SO3_SHADOWDETAILTYPE_ADDITIVE
• SO3_SHADOWDETAILTYPE_MODULATIVE
• SO3_SHADOWDETAILTYPE_INTEGRATED
• SO3_SHADOWDETAILTYPE_STENCIL
• SO3_SHADOWDETAILTYPE_TEXTURE
• SO3_SHADOWTYPE_STENCIL_MODULATIVE
• SO3_SHADOWTYPE_STENCIL_ADDITIVE
• SO3_SHADOWTYPE_TEXTURE_MODULATIVE
• SO3_SHADOWTYPE_TEXTURE_ADDITIVE
• SO3_SHADOWTYPE_TEXTURE_ADDITIVE_INTEGRATED
• SO3_SHADOWTYPE_TEXTURE_MODULATIVE_INTEGRATED

Returns:

I : 1 if success, NIL otherwise

Definition at line 3131 of file SCOLScene.cpp.

int SO3SceneSetShadowTextureCount

(

mmachine

m

)

SO3SceneSetShadowTextureCount : function to defines shadow texture count in the scene.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: number of shadow textures

Returns:

I : 1 if success, NIL otherwise

Definition at line 2397 of file SCOLScene.cpp.

int SO3SceneSetShadowTextureFadeEnd

(

mmachine

m

)

SO3SceneSetShadowTextureFadeEnd : function to defines texture fade end for textured shaodw technique.

Prototype: fun [SO3_SCENE F] I

Parameters:

	SO3_SCENE	: current scene
	F	: distance

Returns:

I : 1 if success, NIL otherwise

Definition at line 2852 of file SCOLScene.cpp.

int SO3SceneSetShadowTextureFadeStart

(

mmachine

m

)

SO3SceneSetShadowTextureFadeStart : function to defines fade start distance for shadows.

Prototype: fun [SO3_SCENE F] I

Parameters:

	SO3_SCENE	: current scene
	F	: distance

Returns:

I : 1 if success, NIL otherwise

Definition at line 2748 of file SCOLScene.cpp.

int SO3SceneSetShadowTextureSize

(

mmachine

m

)

SO3SceneSetShadowTextureSize : function to defines shadow texture size of the scene.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: shadow texture size

Returns:

I : 1 if success, NIL otherwise

Definition at line 2444 of file SCOLScene.cpp.

int SO3SceneSetSkyBox

(

mmachine

m

)

SO3SceneSetSkyBox : function to set a sky box for a scene.

Prototype: fun [SO3_SCENE SO3_MATERIAL F [F F F F] S I I] I

Parameters:

	SO3_SCENE	: current scene
	SO3_MATERIAL	: current material for skyBox
	F	: given distance
	[F	F F F] : given orientation (quaternion)
	S	: given group for resource
	I	: set visible (1 enable/0 disable)
	I	: boolean for draw First on rendering (1 enable/0 disable)

Returns:

I : 1 if success, NIL otherwise

Definition at line 1016 of file SCOLScene.cpp.

int SO3SceneSetSkyBoxEnable

(

mmachine

m

)

SO3SceneSetSkyBox : function to defines visiblity state for a sky box.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: set visible (1 enable/0 disable)

Returns:

I : 1 if success, NIL otherwise

Definition at line 1125 of file SCOLScene.cpp.

int SO3SceneSetSkyDome

(

mmachine

m

)

SO3SceneSetSkyDome : function to set a sky dome for a scene.

Prototype: fun [SO3_SCENE SO3_MATERIAL F [F F F F] F F I I I S I I] I

Parameters:

	SO3_SCENE	: current scene
	SO3_MATERIAL	: current material for SkyDome
	F	: given distance
	[F	F F F] : given orientation (quaternion)
	F	: given curvature
	F	: given tiling
	I	: given xSeg
	I	: given ySeg
	I	: given yKeep
	S	: given group for resource
	I	: set visible (1 enable/0 disable)
	I	: boolean for draw First on rendering (1 enable/0 disable)

Returns:

I : 1 if success, NIL otherwise

Definition at line 1309 of file SCOLScene.cpp.

int SO3SceneSetSkyDomeEnable

(

mmachine

m

)

SO3SceneSetSkyDomeEnable : function to defines visiblity state for a sky dome.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: set visible (1 enable/0 disable)

Returns:

I : 1 if success, NIL otherwise

Definition at line 1422 of file SCOLScene.cpp.

int SO3SceneSetSkyPlane

(

mmachine

m

)

SO3SceneSetSkyPlane : function to set a sky plane for a scene.

Prototype: fun [SO3_SCENE SO3_MATERIAL F [F F F] F F F I I S I I] I

Parameters:

	SO3_SCENE	: current scene
	SO3_MATERIAL	: current material for skyPlane
	F	: given distance
	[F	F F] : given vector
	F	: given scale
	F	: given tiling
	F	: given bow
	I	: given xSeg
	I	: given ySeg
	S	: given group for resource
	I	: set visible (1 enable/0 disable)
	I	: boolean for draw First on rendering (1 enable/0 disable)

Returns:

I : 1 if success, NIL otherwise

Definition at line 1632 of file SCOLScene.cpp.

int SO3SceneSetSkyPlaneEnable

(

mmachine

m

)

SO3SceneSetSkyPlaneEnable : function to defines visiblity state for a sky plane.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: set visible (1 enable/0 disable)

Returns:

I : 1 if success, NIL otherwise

Definition at line 1753 of file SCOLScene.cpp.

int SO3SceneUnloadResource

(

mmachine

m

)

SO3SceneUnloadResource : Unload a resource from Scene TODO!

Prototype: fun [SO3_SCENE S I] I

Parameters:

	SO3_SCENE	: current scene
	S	: name of the resource
	I	: resource type

Returns:

I : 1 if success, NIL otherwise

Definition at line 170 of file SCOLScene.cpp.

int SO3WorldSetFPS

(

mmachine

m

)

SO3WorldSetFPS : defines FPS for physic world.

Prototype: fun [SO3_SCENE I] I

Parameters:

	SO3_SCENE	: current scene
	I	: FPS

Returns:

I : 1 if success, NIL otherwise

Definition at line 912 of file SCOLScene.cpp.

int SO3WorldSetSize

(

mmachine

m

)

SO3WorldSetSize : function to defines world size.

Prototype: fun [SO3_SCENE] I

Parameters:

SO3_SCENE

: current scene

Returns:

I : 1 if success, NIL otherwise

Definition at line 958 of file SCOLScene.cpp.