Project

General

Profile

SO3Engine
Scene

Functions

int SO3CbMaterialCollision (mmachine m)
 SO3CbMaterialCollision : Define the callback scol had to be called when two material ID collide. More...
 
int SO3CbMaterialOverlapStarted (mmachine m)
 SO3CbMaterialOverlapStarted : Define the callback scol had to be called when two material ID start to overlap. More...
 
int SO3CbMaterialOverlapEnded (mmachine m)
 SO3CbMaterialOverlapEnded : Define the callback scol had to be called when two material ID does not overlap together anymore. More...
 
int SO3CbBodyLeaveWorld (mmachine m)
 SO3CbBodyLeaveWorld : Define the scol callback had to be called when a body leave the physic world deprecated. More...
 
int SO3SceneLoadEntity (mmachine m)
 SO3SceneLoadEntity : create an Entity as a new SO3_Object. More...
 
int SO3SceneLoadEntityInBackground (mmachine m)
 SO3SceneLoadEntityInBackground : create an Entity as a new SO3_Object. More...
 
int SO3SceneLoadEntityByResourceName (mmachine m)
 SO3SceneLoadEntityByResourceName : create an Entity as a new SO3_Object. More...
 
int SO3SceneConvertFile (mmachine m)
 SO3SceneConvertFile : Convert a file. More...
 
int SO3SceneLoadFile (mmachine m)
 SO3SceneLoadFile : create an Entity as a new SO3_Object. More...
 
int SO3SceneConvertFileEx (mmachine m)
 SO3SceneConvertFileEx : Convert a file. More...
 
int SO3SceneLoadFileEx (mmachine m)
 SO3SceneLoadFileEx : create an Entity as a new SO3_Object. More...
 
int SO3SceneUnloadResource (mmachine m)
 SO3SceneUnloadResource : Unload a resource from Scene TODO! More...
 
int SO3SceneLoadResource (mmachine m)
 SO3SceneLoadResource : Load a resource in Scene. More...
 
int SO3SceneCloneAnimation (mmachine m)
 SO3SceneCloneAnimation : Clone a SO3_ANIM in Scene. More...
 
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. More...
 
int SO3SceneLoadResourceMaterial (mmachine m)
 SO3SceneLoadResourceMaterial :Load Resource Material in Scene
Deprecated More...
 
int SO3SceneCreate (mmachine m)
 SO3SceneCreate : Create a new scene. More...
 
int SO3SceneDelete (mmachine m)
 SO3SceneDelete : destroy a scene. More...
 
int SO3SceneClear (mmachine m)
 SO3SceneClear : clear a scene. More...
 
int SO3SceneSetSkyBox (mmachine m)
 SO3SceneSetSkyBox : function to set a sky box for a scene. More...
 
int SO3SceneSetSkyBoxEnable (mmachine m)
 SO3SceneSetSkyBox : function to defines visiblity state for a sky box. More...
 
int SO3SceneGetSkyBoxParameters (mmachine m)
 SO3SceneGetSkyBoxParameters : function to get the sky box parameters. More...
 
int SO3SceneSetSkyDome (mmachine m)
 SO3SceneSetSkyDome : function to set a sky dome for a scene. More...
 
int SO3SceneSetSkyDomeEnable (mmachine m)
 SO3SceneSetSkyDomeEnable : function to defines visiblity state for a sky dome. More...
 
int SO3SceneGetSkyDomeParameters (mmachine m)
 SO3SceneGetSkyDomeParameters : function to get the sky dome parameters. More...
 
int SO3SceneSetSkyPlane (mmachine m)
 SO3SceneSetSkyPlane : function to set a sky plane for a scene. More...
 
int SO3SceneSetSkyPlaneEnable (mmachine m)
 SO3SceneSetSkyPlaneEnable : function to defines visiblity state for a sky plane. More...
 
int SO3SceneGetSkyPlaneParameters (mmachine m)
 SO3SceneGetSkyPlaneParameters : function to get the sky plane parameters. More...
 
int SO3SceneSetAmbientLight (mmachine m)
 SO3SceneSetAmbientLight : function to defines ambient light of the scene. More...
 
int SO3SceneGetAmbientLight (mmachine m)
 SO3SceneGetAmbientLight : function to get the ambient light of the scene. More...
 
int SO3SceneGetFogColor (mmachine m)
 SO3SceneGetFogColor : function to get the fog color of the scene. More...
 
int SO3SceneGetFogMode (mmachine m)
 SO3SceneGetFogColor : function to get the fog mode of the scene. More...
 
int SO3SceneGetFogDensity (mmachine m)
 SO3SceneGetFogDensity : function to get the fog density of the scene. More...
 
int SO3SceneGetFogStart (mmachine m)
 SO3SceneGetFogStart : function to get the fog start of the scene. More...
 
int SO3SceneGetFogEnd (mmachine m)
 SO3SceneGetFogEnd : function to get the fog end of the scene. More...
 
int SO3SceneSetFog (mmachine m)
 SO3SceneSetFog : function to defines fog properties of the scene. More...
 
int SO3SceneGetNode (mmachine m)
 SO3SceneGetNode : return a scene node by its name. More...
 
int SO3SceneGetObject (mmachine m)
 SO3SceneGetObject : return a scene object by its name. More...
 
int SO3SceneNodeCreate (mmachine m)
 SO3SceneNodeCreate : Create a new node. More...
 
int SO3SceneParseMaterialsFromGroup (mmachine m)
 SO3SceneParseMaterialsFromGroup : Return the list of materials from a group name. More...
 
int SO3SceneParseCompositorsFromGroup (mmachine m)
 SO3SceneParseCompositorsFromGroup : Return the list of compositors from a group name. More...
 
int SO3SceneParseSchemeFromGroup (mmachine m)
 SO3SceneParseSchemeFromGroup : Return the list of material scheme from a group name. More...
 
int SO3SceneParseParticleSystemsFromGroup (mmachine m)
 SO3SceneParseParticleSystemsFromGroup : Return the list of particle systems from a group name. More...
 
int SO3SceneGetMaterial (mmachine m)
 SO3SceneGetMaterial : Return a material by its name. More...
 
int SO3SceneGetTexture (mmachine m)
 SO3SceneGetTexture : Return a texture by its name. More...
 
int SO3PlaneCreate (mmachine m)
 SO3PlaneCreate : create a plane as a SO3_OBJECT. More...
 
int SO3SphereCreate (mmachine m)
 SO3SphereCreate : create a sphere as a SO3_OBJECT. More...
 
int SO3ConeCreate (mmachine m)
 SO3ConeCreate : create a cone as a SO3_OBJECT. More...
 
int SO3OctahedronCreate (mmachine m)
 SO3OctahedronCreate : create an octahedron as a SO3_OBJECT. More...
 
int SO3SceneGetAnimation (mmachine m)
 SO3SceneGetAnimation : return an animation by its name. More...
 
int SO3SceneGetAnimations (mmachine m)
 SO3SceneGetAnimations : Return the list of animations on a scene. More...
 
int SO3SceneGetNumAnimations (mmachine m)
 SO3SceneGetNumAnimations : return an animation by its name. More...
 
int SO3SceneSetMaterialsPointSize (mmachine m)
 SO3SceneSetMaterialsPointSize : Set all scene materials point cloud size. More...
 
int SO3CbScenePreRender (mmachine m)
 SO3CbScenePreRender : defines callback for pre render event. More...
 
int SO3CbScenePreRenderPhysic (mmachine m)
 SO3CbScenePreRenderPhysic : defines callback for pre render event, but after the animations and before physics update. More...
 
int SO3CbScenePreRender2 (mmachine m)
 SO3CbScenePreRender2 : defines callback for pre render event, but after the animations and physics update. More...
 
int SO3CbScenePostRender (mmachine m)
 SO3CbScenePostRender : defines callback for post render event. More...
 
int SO3BufferGetLastMouseInfos (mmachine m)
 SO3BufferGetLastMouseInfos : get Last raycast info of a given render window. More...
 

Detailed Description

Scol functions definition

Function Documentation

◆ SO3BufferGetLastMouseInfos()

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 3471 of file SO3SCOL.cpp.

◆ SO3CbBodyLeaveWorld()

int SO3CbBodyLeaveWorld ( mmachine  m)

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

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 8552 of file SCOLPhysics.cpp.

◆ SO3CbMaterialCollision()

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 8250 of file SCOLPhysics.cpp.

◆ SO3CbMaterialOverlapEnded()

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 8452 of file SCOLPhysics.cpp.

◆ SO3CbMaterialOverlapStarted()

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 8351 of file SCOLPhysics.cpp.

◆ SO3CbScenePostRender()

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 microseconds
Returns
SO3_SCENE : same scene object if success

Definition at line 4046 of file SCOLScene.cpp.

◆ SO3CbScenePreRender()

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 microseconds
Returns
SO3_SCENE : same scene object if success

Definition at line 3970 of file SCOLScene.cpp.

◆ SO3CbScenePreRender2()

int SO3CbScenePreRender2 ( mmachine  m)

SO3CbScenePreRender2 : defines callback for pre render event, but after the animations and physics update.

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 microseconds
Returns
SO3_SCENE : same scene object if success

Definition at line 4021 of file SCOLScene.cpp.

◆ SO3CbScenePreRenderPhysic()

int SO3CbScenePreRenderPhysic ( mmachine  m)

SO3CbScenePreRenderPhysic : defines callback for pre render event, but after the animations and before physics update.

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: physic time step in microseconds
Returns
SO3_SCENE : same scene object if success

Definition at line 3995 of file SCOLScene.cpp.

◆ SO3ConeCreate()

int SO3ConeCreate ( mmachine  m)

SO3ConeCreate : create a cone as a SO3_OBJECT.

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

Parameters
SO3_SCENE: current scene
S: group name
S: plane name
F: radius
F: height
I: segments
Returns
SO3_OBJECT : Cone created if success, NIL otherwise

Definition at line 3635 of file SCOLScene.cpp.

◆ SO3OctahedronCreate()

int SO3OctahedronCreate ( mmachine  m)

SO3OctahedronCreate : create an octahedron as a SO3_OBJECT.

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

Parameters
SO3_SCENE: current scene
S: group name
S: plane name
F: base
F: bottom
F: up
Returns
SO3_OBJECT : Octahedron created if success, NIL otherwise

Definition at line 3714 of file SCOLScene.cpp.

◆ SO3PlaneCreate()

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
[FF] : width and height
[II] : plane segmentation X and Y (1 default)
[FF] : UV tile (U and V, 1.0 default)
Returns
SO3_OBJECT : Plane created if success, NIL otherwise

Definition at line 3471 of file SCOLScene.cpp.

◆ SO3SceneClear()

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 1519 of file SCOLScene.cpp.

◆ SO3SceneCloneAnimation()

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 1161 of file SCOLScene.cpp.

◆ SO3SceneCloneAnimTrack()

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 1230 of file SCOLScene.cpp.

◆ SO3SceneConvertFile()

int SO3SceneConvertFile ( mmachine  m)

SO3SceneConvertFile : Convert a file.

Prototype: fun [P S I] P

Parameters
P: file path
S: export path related to the scol partition
I: loader flags
Returns
P : the scene file path if success, NIL otherwise

Definition at line 373 of file SCOLScene.cpp.

◆ SO3SceneConvertFileEx()

int SO3SceneConvertFileEx ( mmachine  m)

SO3SceneConvertFileEx : Convert a file.

Prototype: fun [P S I F] P

Parameters
P: file path
S: export path related to the scol partition
I: loader flags
F: scale factor
Returns
P : the scene file path if success, NIL otherwise

Definition at line 675 of file SCOLScene.cpp.

◆ SO3SceneCreate()

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 1379 of file SCOLScene.cpp.

◆ SO3SceneDelete()

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 1491 of file SCOLScene.cpp.

◆ SO3SceneGetAmbientLight()

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 2606 of file SCOLScene.cpp.

◆ SO3SceneGetAnimation()

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 3789 of file SCOLScene.cpp.

◆ SO3SceneGetAnimations()

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 3835 of file SCOLScene.cpp.

◆ SO3SceneGetFogColor()

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

◆ SO3SceneGetFogDensity()

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 2725 of file SCOLScene.cpp.

◆ SO3SceneGetFogEnd()

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 2793 of file SCOLScene.cpp.

◆ SO3SceneGetFogMode()

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 2691 of file SCOLScene.cpp.

◆ SO3SceneGetFogStart()

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 2759 of file SCOLScene.cpp.

◆ SO3SceneGetMaterial()

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 3350 of file SCOLScene.cpp.

◆ SO3SceneGetNode()

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 2901 of file SCOLScene.cpp.

◆ SO3SceneGetNumAnimations()

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 3896 of file SCOLScene.cpp.

◆ SO3SceneGetObject()

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 2945 of file SCOLScene.cpp.

◆ SO3SceneGetSkyBoxParameters()

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 1847 of file SCOLScene.cpp.

◆ SO3SceneGetSkyDomeParameters()

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 2131 of file SCOLScene.cpp.

◆ SO3SceneGetSkyPlaneParameters()

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 2444 of file SCOLScene.cpp.

◆ SO3SceneGetTexture()

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 texture name
Returns
SO3_TEXTURE : texture if success, NIL otherwise

Definition at line 3402 of file SCOLScene.cpp.

◆ SO3SceneLoadEntity()

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 88 of file SCOLScene.cpp.

◆ SO3SceneLoadEntityByResourceName()

int SO3SceneLoadEntityByResourceName ( mmachine  m)

SO3SceneLoadEntityByResourceName : create an Entity as a new SO3_Object.

Prototype: fun [SO3_SCENE S S S] SO3_OBJECT

Parameters
SO3_SCENE: current scene
S: group name
S: given name for entity
S: mesh resource name
Returns
SO3_OBJECT : Entity object created if success, NIL otherwise

Definition at line 274 of file SCOLScene.cpp.

◆ SO3SceneLoadEntityInBackground()

int SO3SceneLoadEntityInBackground ( mmachine  m)

SO3SceneLoadEntityInBackground : create an Entity as a new SO3_Object.

Prototype: fun [SO3_SCENE S S P fun [SO3_OBJECT u0] u1 u0] SO3_OBJECT

Parameters
SO3_SCENE: current scene
S: group name
S: given name for entity
P: given mesh path
fun[SO3_OBJECT u0] u1 : callback on mesh loaded
u0: user parameter
Returns
SO3_OBJECT : Entity object created if success, NIL otherwise

Definition at line 190 of file SCOLScene.cpp.

◆ SO3SceneLoadFile()

int SO3SceneLoadFile ( mmachine  m)

SO3SceneLoadFile : create an Entity as a new SO3_Object.

Prototype: fun [SO3_SCENE S P SO3_OBJECT I] I

Parameters
SO3_SCENE: current scene
S: group name
P: file path
SO3_OBJECT: parent node, can't be NIL
I: loader flags
Returns
I : 1 if success, NIL otherwise

Definition at line 484 of file SCOLScene.cpp.

◆ SO3SceneLoadFileEx()

int SO3SceneLoadFileEx ( mmachine  m)

SO3SceneLoadFileEx : create an Entity as a new SO3_Object.

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

Parameters
SO3_SCENE: current scene
S: group name
P: file path
SO3_OBJECT: parent node, can't be NIL
I: loader flags
F: scale factor
Returns
I : 1 if success, NIL otherwise

Definition at line 792 of file SCOLScene.cpp.

◆ SO3SceneLoadResource()

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
  • SO3_RESOURCE_COMPOSITOR
Returns
I : 1 if success, NIL otherwise

Definition at line 1101 of file SCOLScene.cpp.

◆ SO3SceneLoadResourceMaterial()

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 1259 of file SCOLScene.cpp.

◆ SO3SceneNodeCreate()

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 3000 of file SCOLScene.cpp.

◆ SO3SceneParseCompositorsFromGroup()

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 3125 of file SCOLScene.cpp.

◆ SO3SceneParseMaterialsFromGroup()

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 3050 of file SCOLScene.cpp.

◆ SO3SceneParseParticleSystemsFromGroup()

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 3277 of file SCOLScene.cpp.

◆ SO3SceneParseSchemeFromGroup()

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 3199 of file SCOLScene.cpp.

◆ SO3SceneSetAmbientLight()

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 2563 of file SCOLScene.cpp.

◆ SO3SceneSetFog()

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 2838 of file SCOLScene.cpp.

◆ SO3SceneSetMaterialsPointSize()

int SO3SceneSetMaterialsPointSize ( mmachine  m)

SO3SceneSetMaterialsPointSize : Set all scene materials point cloud size.

Prototype: fun [SO3_SCENE F] SO3_SCENE

Parameters
SO3_SCENE: current scene
F: the new point size
Returns
SO3_SCENE : the same scene on success, NIL otherwise

Definition at line 3929 of file SCOLScene.cpp.

◆ SO3SceneSetSkyBox()

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
[FF 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 1676 of file SCOLScene.cpp.

◆ SO3SceneSetSkyBoxEnable()

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 1771 of file SCOLScene.cpp.

◆ SO3SceneSetSkyDome()

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
[FF 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 1957 of file SCOLScene.cpp.

◆ SO3SceneSetSkyDomeEnable()

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 2057 of file SCOLScene.cpp.

◆ SO3SceneSetSkyPlane()

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
[FF 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 2262 of file SCOLScene.cpp.

◆ SO3SceneSetSkyPlaneEnable()

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 2369 of file SCOLScene.cpp.

◆ SO3SceneUnloadResource()

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 987 of file SCOLScene.cpp.

◆ SO3SphereCreate()

int SO3SphereCreate ( mmachine  m)

SO3SphereCreate : create a sphere as a SO3_OBJECT.

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

Parameters
SO3_SCENE: current scene
S: group name
S: plane name
F: radius
I: rings
I: segments
Returns
SO3_OBJECT : Sphere created if success, NIL otherwise

Definition at line 3556 of file SCOLScene.cpp.