Unigine.ObjectMeshCluster Class

ObjectMeshCluster Class

Properties

int NumMeshes#

float FadeDistance#

float VisibleDistance#

string MeshPath#

Object.STREAMING_OBJECT_MESH MeshStreamingModeVRAM#

Object.STREAMING_OBJECT_MESH MeshStreamingModeRAM#

bool IsMeshLoadedVRAM#

bool IsMeshLoadedRAM#

bool IsMeshNull#

bool MeshProceduralMode#

Members

ObjectMeshCluster ( string path ) #

Arguments

• string path - Path to the base mesh file.

ObjectMeshCluster ( ) #

int AddMeshTransform ( ) #

Return value

void SetMeshTransform ( int num, mat4 transform ) #

Arguments

• int num - Mesh instance number.
• mat4 transform - Mesh transformation matrix.

mat4 GetMeshTransform ( int num ) #

Arguments

• int num - Mesh instance number.

Return value

void RemoveMeshTransform ( int num ) #

Arguments

• int num - Mesh instance number.

void RemoveMeshTransformFast ( int num ) #

Arguments

• int num - Mesh instance number.

void ClearMeshes ( ) #

void CreateMeshes ( mat4[] world_transforms ) #

Arguments

• mat4[] world_transforms - Transformations vector in world coordinates.

void AppendMeshes ( mat4[] world_transforms ) #

Arguments

• mat4[] world_transforms - Transformations vector in world coordinates.

void ApplyMeshProcedural ( Mesh mesh ) #

ObjectMeshCluster my_mesh_cluster;
// ...

// switch the object to procedural mesh mode
my_mesh_cluster.MeshProceduralMode = true;

// update the source mesh of the "my_mesh_cluster" object via the source_mesh instance
my_mesh_cluster.ApplyMeshProcedural(source_mesh);

Arguments

• Mesh mesh - Mesh to be applied.

static int type ( ) #

Return value

bool RemoveClusterTransforms ( WorldBoundBox bb ) #

Arguments

• WorldBoundBox bb - Bounding box defining the area, within which the cluster meshes are to be removed from the cluster.

Return value

bool RemoveClusterTransformsFromSphere ( WorldBoundSphere bb ) #

Arguments

• WorldBoundSphere bb - Bounding sphere defining the area, for which the transformations of cluster meshes are to be collected.

Return value

bool DetachClusterTransforms ( WorldBoundBox bb, mat4[] OUT_transforms ) #

Arguments

• WorldBoundBox bb - Bounding box defining the area, within which the cluster meshes are to be detached from the cluster.
• mat4[] OUT_transforms - Buffer to store transformations of detached cluster meshes.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

bool DetachClusterWorldTransforms ( WorldBoundBox bb, mat4[] OUT_transforms ) #

Arguments

• WorldBoundBox bb - Bounding box defining the area, within which the cluster meshes are to be detached from the cluster.
• mat4[] OUT_transforms - Buffer to store transformations of detached cluster meshes.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

bool DetachClusterWorldTransformsFromSphere ( WorldBoundSphere bb, mat4[] OUT_transforms ) #

Arguments

• WorldBoundSphere bb - Bounding sphere defining the area, for which the transformations of cluster meshes are to be collected.
• mat4[] OUT_transforms - Buffer to store transformations of cluster meshes, in world coordinates.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

bool GetClusterTransforms ( WorldBoundBox bounds, mat4[] OUT_transforms ) #

Arguments

• WorldBoundBox bounds - Bounding box defining the area, for which the transformations of cluster meshes are to be collected.
• mat4[] OUT_transforms - Buffer to store transformations of cluster meshes.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

bool GetClusterWorldTransforms ( WorldBoundBox bounds, mat4[] OUT_transforms ) #

Arguments

• WorldBoundBox bounds - Bounding box defining the area, for which the transformations of cluster meshes are to be collected.
• mat4[] OUT_transforms - Buffer to store transformations of cluster meshes, in world coordinates.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

bool GetClusterWorldTransformsFromSphere ( WorldBoundSphere bounds, mat4[] OUT_transforms ) #

Arguments

• WorldBoundSphere bounds - Bounding sphere defining the area, for which the transformations of cluster meshes are to be collected.
• mat4[] OUT_transforms - Buffer to store transformations of cluster meshes, in world coordinates.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

bool GetInstancesFromSphere ( WorldBoundSphere bb, int[] OUT_instances ) #

Arguments

• WorldBoundSphere bb - Bounding sphere defining the area within which instances are to be collected.
• int[] OUT_instances - Vector containing instance indices.
  Notice

  This output buffer is to be filled by the Engine as a result of executing the method.

Return value

MeshStatic GetMeshInfo ( ) #

Return value

MeshStatic GetMeshForce ( ) #

Return value

MeshStatic GetMeshAsync ( ) #

Return value

MeshStatic GetMeshForceVRAM ( ) #

Return value

MeshStatic GetMeshAsyncVRAM ( ) #

Return value

bool LoadAsyncVRAM ( ) #

Return value

bool LoadAsyncRAM ( ) #

Return value

bool LoadForceVRAM ( ) #

Return value

bool LoadForceRAM ( ) #

Return value

bool AsyncCalculateNodes ( int surface ) #

Arguments

• int surface - Mesh surface number.

Return value

bool AsyncCalculateEdges ( int surface ) #

Arguments

• int surface - Mesh surface number.

Return value