Functions
int	SO3EntityNumOfSubEntities (mmachine m)
	main include

int	SO3EntitySetVisibilityFlags (mmachine m)
	SO3EntitySetVisibilityFlags : Set the visibility flags corresponding to viewports masks.

int	SO3EntityGetVisibilityFlags (mmachine m)
	SO3EntityGetVisibilityFlags : Get the visibility flags corresponding to viewports masks.

int	SO3EntitySetVisibilityFlagIndexEnable (mmachine m)
	SO3EntitySetVisibilityFlagIndexEnable : Set the visibility flag at the given index (do not change other flags!).

int	SO3EntityGetVisibilityFlagIndexEnable (mmachine m)
	SO3EntityGetVisibilityFlagIndexEnable : Retrieve if the visibility flag at the given index is enabled or not (do not returns other flags!).

int	SO3EntityGenerateLOD (mmachine m)
	SO3EntityGenerateLOD : Generate LOD on an entity.

int	SO3EntityGetMaterialByIndex (mmachine m)
	SO3EntityGetMaterialByIndex : Return the material associated with a given subEntity for a given node.

int	SO3EntityMaterialList (mmachine m)
	SO3EntityMaterialList : return the list of material applied on an Entity.

int	SO3EntityAttachSkeleton (mmachine m)
	SO3EntityAttachSkeleton : Load a skeleton resource in Scene.

int	SO3EntityGetSkeleton (mmachine m)
	SO3EntityGetSkeleton : Get a skeleton resource from the entity.

int	SO3EntitySetMaterial (mmachine m)
	SO3EntitySetMaterial : Set a material on Entity.

int	SO3EntityGetResourceGroup (mmachine m)
	SO3EntityGetResourceGroup : Get the resource group of an Entity.

int	SO3EntitySetMinPixelSize (mmachine m)
	SO3EntitySetMinPixelSize : Set the visibility minmum pixel size.

int	SO3EntityGetMinPixelSize (mmachine m)
	SO3EntityGetMinPixelSize : Get the visibility minimum pixel size.

Detailed Description

Scol functions definition

Function Documentation

◆ SO3EntityAttachSkeleton()

int SO3EntityAttachSkeleton ( mmachine m )

SO3EntityAttachSkeleton : Load a skeleton resource in Scene.

Prototype: fun [SO3_OBJECT P] SO3_OBJECT

Parameters

SO3_OBJECT	: entity to which the loaded skeleton will be attached
P	: resource skeleton path

Returns: SO3_OBJECT : The entity where the skeleton is attached if success, NIL otherwise

Definition at line 472 of file SCOLEntity.cpp.

◆ SO3EntityGenerateLOD()

int SO3EntityGenerateLOD ( mmachine m )

SO3EntityGenerateLOD : Generate LOD on an entity.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current entity
I	: number of LOD levels, 0 to disable LOD

Returns: I : 1 on success, NIL on error

Definition at line 282 of file SCOLEntity.cpp.

◆ SO3EntityGetMaterialByIndex()

int SO3EntityGetMaterialByIndex ( mmachine m )

SO3EntityGetMaterialByIndex : Return the material associated with a given subEntity for a given node.

Prototype: fun [SO3_OBJECT I] SO3_MATERIAL

Parameters

SO3_OBJECT	: current node
I	: given index

Returns: SO3_MATERIAL : The subEntity material if success , NIL otherwise

Definition at line 337 of file SCOLEntity.cpp.

◆ SO3EntityGetMinPixelSize()

int SO3EntityGetMinPixelSize ( mmachine m )

SO3EntityGetMinPixelSize : Get the visibility minimum pixel size.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT : current entity

Returns: F : The minimum pixel size

Definition at line 844 of file SCOLEntity.cpp.

◆ SO3EntityGetResourceGroup()

int SO3EntityGetResourceGroup ( mmachine m )

SO3EntityGetResourceGroup : Get the resource group of an Entity.

Prototype: fun [SO3_OBJECT] S

Parameters

SO3_OBJECT	: given entity
I	: subEntity index

Returns: S : the groupname if success, NIL otherwise

Definition at line 752 of file SCOLEntity.cpp.

◆ SO3EntityGetSkeleton()

int SO3EntityGetSkeleton ( mmachine m )

SO3EntityGetSkeleton : Get a skeleton resource from the entity.

Prototype: fun [SO3_OBJECT] P

Parameters

SO3_OBJECT : entity

Returns: P : resource skeleton path if success, NIL otherwise

Definition at line 650 of file SCOLEntity.cpp.

◆ SO3EntityGetVisibilityFlagIndexEnable()

int SO3EntityGetVisibilityFlagIndexEnable ( mmachine m )

SO3EntityGetVisibilityFlagIndexEnable : Retrieve if the visibility flag at the given index is enabled or not (do not returns other flags!).

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current entity
I	: flag index. Flag index range is from 0 to 31 (which means that 32 different visibility layers are possible)

Returns: I : 1 if flag is enable, false if disable, NIL on error

Definition at line 229 of file SCOLEntity.cpp.

◆ SO3EntityGetVisibilityFlags()

int SO3EntityGetVisibilityFlags ( mmachine m )

SO3EntityGetVisibilityFlags : Get the visibility flags corresponding to viewports masks.

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT : current entity

Returns: I : flags

Definition at line 137 of file SCOLEntity.cpp.

◆ SO3EntityMaterialList()

int SO3EntityMaterialList ( mmachine m )

SO3EntityMaterialList : return the list of material applied on an Entity.

Prototype: fun [SO3_OBJECT] [SO3_MATERIAL r1]

Parameters

SO3_OBJECT : given entity

Returns: [SO3_MATERIAL r1] : Materials list if success, NIL otherwise

Definition at line 394 of file SCOLEntity.cpp.

◆ SO3EntityNumOfSubEntities()

int SO3EntityNumOfSubEntities ( mmachine m )

main include

SO3EntityNumOfSubEntities : Return the number of subEntities for a given entity

Prototype: fun [SO3_OBJECT] I

Parameters

SO3_OBJECT : current entity

Returns: I : Number of SubEntities if success , NIL otherwise

Definition at line 54 of file SCOLEntity.cpp.

◆ SO3EntitySetMaterial()

int SO3EntitySetMaterial ( mmachine m )

SO3EntitySetMaterial : Set a material on Entity.

Prototype: fun [SO3_OBJECT SO3_MATERIAL I] I

Parameters

SO3_OBJECT	: given entity
SO3_MATERIAL	: given material
I	: subEntity index

Returns: I : 1 if success, NIL otherwise

Definition at line 701 of file SCOLEntity.cpp.

◆ SO3EntitySetMinPixelSize()

int SO3EntitySetMinPixelSize ( mmachine m )

SO3EntitySetMinPixelSize : Set the visibility minmum pixel size.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current entity
F	: pixel size

Returns: I : 1 success, NIL otherwise

Definition at line 797 of file SCOLEntity.cpp.

◆ SO3EntitySetVisibilityFlagIndexEnable()

int SO3EntitySetVisibilityFlagIndexEnable ( mmachine m )

SO3EntitySetVisibilityFlagIndexEnable : Set the visibility flag at the given index (do not change other flags!).

Prototype: fun [SO3_OBJECT I I] I

Parameters

SO3_OBJECT	: current entity
I	: flag index. Flag index range is from 0 to 31 (which means that 32 different visibility layers are possible)
I	: 1 to enable, 0 or NIL to disable

Returns: I : 1 if success, NIL otherwise

Definition at line 178 of file SCOLEntity.cpp.

◆ SO3EntitySetVisibilityFlags()

int SO3EntitySetVisibilityFlags ( mmachine m )

SO3EntitySetVisibilityFlags : Set the visibility flags corresponding to viewports masks.

Prototype: fun [SO3_OBJECT I] I

Parameters

SO3_OBJECT	: current entity
I	: flags

Returns: I : 1 success, NIL otherwise

Definition at line 94 of file SCOLEntity.cpp.

Functions

Detailed Description

Function Documentation

◆ SO3EntityAttachSkeleton()

◆ SO3EntityGenerateLOD()

◆ SO3EntityGetMaterialByIndex()

◆ SO3EntityGetMinPixelSize()

◆ SO3EntityGetResourceGroup()

◆ SO3EntityGetSkeleton()

◆ SO3EntityGetVisibilityFlagIndexEnable()

◆ SO3EntityGetVisibilityFlags()

◆ SO3EntityMaterialList()

◆ SO3EntityNumOfSubEntities()

◆ SO3EntitySetMaterial()

◆ SO3EntitySetMinPixelSize()

◆ SO3EntitySetVisibilityFlagIndexEnable()

◆ SO3EntitySetVisibilityFlags()