Unigine::ObjectMeshCluster Class

功能列表:

Name	说明/描述 View: Sort by:
*create*	ObjectMeshCluster constructor.
setFadeDistance	Sets the distance up to which meshes handled by the mesh cluster will be fading out (that is, fewer meshes will be rendered instead of all).
getFadeDistance	Returns the distance up to which meshes handled by the mesh cluster will be fading out.
setMeshPath	Sets a path to the mesh hadled by the Mesh Cluster.
getMeshPath	Returns the path to the source .
getNumMeshes	Returns the total number of meshes handled by the mesh cluster.
setVisibleDistance	Sets the distance up to which meshes handled by the mesh cluster will be rendered.
getVisibleDistance	Returns the distance up to which meshes handled by the mesh cluster are rendered.
setMeshProceduralMode	Sets a value indicating if the base mesh used for the object is procedural.
isMeshProceduralMode	Returns a value indicating if the base mesh used for the object is procedural.
isMeshNull	Returns a value indicating if the base mesh used for the object is null (does not exist, unassigned, not loaded, etc.
isMeshLoadedRAM	Returns a value indicating if the base mesh used for the object is loaded to memory (RAM).
isMeshLoadedVRAM	Returns a value indicating if the base mesh used for the object is loaded to video memory (VRAM).
setMeshStreamingModeRAM	Sets the streaming mode for loading the mesh to memory (RAM).
getMeshStreamingModeRAM	Returns the current streaming mode for loading the mesh to memory (RAM).
setMeshStreamingModeVRAM	Sets the streaming mode for loading the mesh to video memory (VRAM).
getMeshStreamingModeVRAM	Returns the current streaming mode for loading the mesh to video memory (VRAM).
addMeshTransform	Adds a new mesh instance transformation to the Mesh Cluster.
setMeshTransform	Sets the transformation for the given mesh instance.
getMeshTransform	Returns the transformation of the given mesh instance.
removeMeshTransform	Removes the transformation of the specified mesh instance from the cluster.
removeMeshTransformFast	Removes the transformation of the specified mesh instance from the cluster.
clearMeshes	Deletes all meshes currently baked into mesh cluster.
createMeshes	Creates meshes in accordance with the transformations vector (world coordinates) and bakes them into the cluster.
appendMeshes	Appends new meshes with transformations stored in the specified vector (world coordinates) and bakes them into the cluster.
applyMeshProcedural	Sets the specified mesh as the base mesh for the object.
type	Returns the type of the node.
removeClusterTransforms	Removes cluster meshes, found within the specified bounding box, from the cluster.
removeClusterTransformsFromSphere	Removes cluster meshes, found within the specified bounding sphere, from the cluster.
detachClusterTransforms	Detaches cluster meshes found within the area specified by the given bounding box from the cluster and puts their transformations (local coordinates) to the specified buffer.
detachClusterWorldTransforms	Detaches cluster meshes found within the area specified by the given bounding box from the cluster and puts their transformations (world coordinates) to the specified buffer.
detachClusterWorldTransformsFromSphere	Detaches cluster meshes found within the area specified by the given bounding box from the cluster and puts their transformations (world coordinates) to the specified buffer.
getClusterTransforms	Collects transformations (local coordinates) for all cluster meshes within the area specified by the given bounding box and puts them to the specified buffer.
getClusterWorldTransforms	Collects transformations (world coordinates) for all cluster meshes within the area specified by the given bounding box and puts them to the specified buffer.
getClusterWorldTransformsFromSphere	Collects transformations (world coordinates) for all cluster meshes within the area specified by the given bounding sphere and puts them to the specified buffer.
getInstancesFromSphere	Returns the indices of instances inside the bounding sphere.
getMeshInfo	Returns the base mesh that stores data on mesh bounds, surfaces, their number, names, and bounds, but doesn't contain any geometry.
getMeshForce	Returns the base mesh used for the object.
getMeshAsync	Returns the base mesh used for the object asynchronously.
getMeshForceVRAM	Returns the base mesh used for the object and loads it to video memory (VRAM).
getMeshAsyncVRAM	Returns the base mesh used for the object asynchronously and loads it to video memory (VRAM).
loadAsyncVRAM	Asynchronously loads the mesh to video memory (VRAM) if the async streaming mode for meshes is enabled.
loadAsyncRAM	Asynchronously loads the mesh to memory (RAM) if the async streaming mode for meshes is enabled.
loadForceVRAM	Performs force-loading of the mesh to video memory (VRAM) immediately.
loadForceRAM	Performs force-loading of the mesh to memory (RAM) immediately.
asyncCalculateNodes	Asynchronously calculates the mesh surface internal spatial tree used for quick calculation of collisions and intersections.
asyncCalculateEdges	Asynchronously calculates the edges of the mesh surface geometry.

ObjectMeshCluster Class

Members

static ObjectMeshClusterPtr create ( const char * path ) #

ObjectMeshCluster constructor. Creates a mesh cluster with a base mesh loaded from the specified file.

Arguments

const char * path - Path to the base mesh file.

static ObjectMeshClusterPtr create ( ) #

ObjectMeshCluster constructor. Creates an empty mesh cluster

void setFadeDistance ( float distance ) #

Sets the distance up to which meshes handled by the mesh cluster will be fading out (that is, fewer meshes will be rendered instead of all). The distance is measured starting from the visible distance. The default is 0. Using fade distance allows the objects to disappear one by one until up to the fade distance only a few left. It makes the disappearing smooth and much less noticeable.

Arguments

float distance - Fading distance for meshes in units. If a negative value is provided, 0 will be used instead.

float getFadeDistance ( ) const#

Returns the distance up to which meshes handled by the mesh cluster will be fading out. The default is 0.

Return value

Fading distance for meshes in units.

void setMeshPath ( const char * path ) #

Sets a path to the mesh hadled by the Mesh Cluster. Does not update mesh immediately using the new path. If the mesh is in the procedural mode, it will be reset.

Arguments

const char * path - New path to the source .mesh-file to be set.

const char * getMeshPath ( ) const#

Returns the path to the source .mesh-file of the base mesh handled by Mesh Cluster.

Return value

Path to the source .mesh-file.

int addMeshTransform ( ) #

Adds a new mesh instance transformation to the Mesh Cluster. To set the new added transformation pass the return value of this method to the setMeshTransform() method.

Return value

Number of the last added mesh instance.

void setMeshTransform ( int num, const Math::mat4 & transform ) #

Sets the transformation for the given mesh instance.

Arguments

int num - Mesh instance number.
const Math::mat4 & transform - Mesh transformation matrix.

Math::mat4 getMeshTransform ( int num ) const#

Returns the transformation of the given mesh instance.

Arguments

int num - Mesh instance number.

Return value

Mesh transformation matrix.

void removeMeshTransform ( int num ) #

Removes the transformation of the specified mesh instance from the cluster.

Arguments

int num - Mesh instance number.

void removeMeshTransformFast ( int num ) #

Removes the transformation of the specified mesh instance from the cluster.

Arguments

int num - Mesh instance number.

int getNumMeshes ( ) const#

Returns the total number of meshes handled by the mesh cluster.

Return value

Number of meshes.

void setVisibleDistance ( float distance ) #

Sets the distance up to which meshes handled by the mesh cluster will be rendered. The default is infinity (in this case, fade distance will be ignored).

Arguments

float distance - Visibility distance for meshes in units. If a negative value is provided, 0 will be used instead.

float getVisibleDistance ( ) const#

Returns the distance up to which meshes handled by the mesh cluster are rendered. The default is infinity (in this case, fade distance is ignored).

Return value

Visibility distance for meshes in units.

void clearMeshes ( ) #

Deletes all meshes currently baked into mesh cluster.

void createMeshes ( const Vector< Math::Mat4> & world_transforms ) #

Creates meshes in accordance with the transformations vector (world coordinates) and bakes them into the cluster. All baked meshes are identical to the source mesh and have the same material applied to their surfaces.

Arguments

const Vector< Math::Mat4> & world_transforms - Transformations vector in world coordinates.

void appendMeshes ( const Vector< Math::Mat4> & world_transforms ) #

Appends new meshes with transformations stored in the specified vector (world coordinates) and bakes them into the cluster. All baked meshes are identical to the source mesh and have the same material applied to their surfaces.

Arguments

const Vector< Math::Mat4> & world_transforms - Transformations vector in world coordinates.

void applyMeshProcedural ( const Ptr<Mesh> & mesh ) #

Sets the specified mesh as the base mesh for the object. The object must be in the procedural mesh mode.

Source code (C++)

ObjectMeshClusterPtr my_mesh_cluster;
// ...

// switch the object to procedural mesh mode
my_mesh_cluster->setMeshProceduralMode(true);

// update the source mesh of the "my_mesh_cluster" object via the source_mesh instance
my_mesh_cluster->applyMeshProcedural(source_mesh);

Arguments

const Ptr<Mesh> & mesh - Mesh to be applied.

static int type ( ) #

Returns the type of the node.

Return value

Node type identifier.

bool removeClusterTransforms ( const Math::WorldBoundBox & bb ) #

Removes cluster meshes, found within the specified bounding box, from the cluster.

Arguments

const Math::WorldBoundBox & bb - Bounding box defining the area, within which the cluster meshes are to be removed from the cluster.

Return value

true if cluster meshes, found within the specified bounding box are successfully removed; otherwise, false.

bool removeClusterTransformsFromSphere ( const Math::WorldBoundSphere & bb ) #

Removes cluster meshes, found within the specified bounding sphere, from the cluster.

Arguments

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

Return value

true if cluster meshes, found within the specified bounding sphere are successfully removed; otherwise, false.

bool detachClusterTransforms ( const Math::WorldBoundBox & bb, Vector< Math::mat4> & OUT_transforms ) #

Detaches cluster meshes found within the area specified by the given bounding box from the cluster and puts their transformations (local coordinates) to the specified buffer.

Arguments

const Math::WorldBoundBox & bb - Bounding box defining the area, within which the cluster meshes are to be detached from the cluster.
Vector< Math::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

true if cluster meshes have been detached from the cluster; otherwise false.

bool detachClusterWorldTransforms ( const Math::WorldBoundBox & bb, Vector< Math::Mat4> & OUT_transforms ) #

Detaches cluster meshes found within the area specified by the given bounding box from the cluster and puts their transformations (world coordinates) to the specified buffer.

Arguments

const Math::WorldBoundBox & bb - Bounding box defining the area, within which the cluster meshes are to be detached from the cluster.
Vector< Math::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

true if cluster meshes have been detached from the cluster; otherwise false.

bool detachClusterWorldTransformsFromSphere ( const Math::WorldBoundSphere & bb, Vector< Math::Mat4> & OUT_transforms ) #

Detaches cluster meshes found within the area specified by the given bounding box from the cluster and puts their transformations (world coordinates) to the specified buffer.

Arguments

const Math::WorldBoundSphere & bb - Bounding sphere defining the area, for which the transformations of cluster meshes are to be collected.
Vector< Math::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

true if cluster meshes have been detached from the cluster; otherwise false.

bool getClusterTransforms ( const Math::WorldBoundBox & bounds, Vector< Math::mat4> & OUT_transforms ) #

Collects transformations (local coordinates) for all cluster meshes within the area specified by the given bounding box and puts them to the specified buffer.

Arguments

const Math::WorldBoundBox & bounds - Bounding box defining the area, for which the transformations of cluster meshes are to be collected.
Vector< Math::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

true, if there are transformations of cluster meshes; or false, if there are no transformations of cluster meshes found.

bool getClusterWorldTransforms ( const Math::WorldBoundBox & bounds, Vector< Math::Mat4> & OUT_transforms ) #

Collects transformations (world coordinates) for all cluster meshes within the area specified by the given bounding box and puts them to the specified buffer.

Arguments

const Math::WorldBoundBox & bounds - Bounding box defining the area, for which the transformations of cluster meshes are to be collected.
Vector< Math::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

true, if there are transformations of cluster meshes; or false, if there are no transformations of cluster meshes within the specified area.

bool getClusterWorldTransformsFromSphere ( const Math::WorldBoundSphere & bounds, Vector< Math::Mat4> & OUT_transforms ) #

Collects transformations (world coordinates) for all cluster meshes within the area specified by the given bounding sphere and puts them to the specified buffer.

Arguments

const Math::WorldBoundSphere & bounds - Bounding sphere defining the area, for which the transformations of cluster meshes are to be collected.
Vector< Math::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

true, if there are transformations of cluster meshes; or false, if there are no transformations of cluster meshes within the specified area.

bool getInstancesFromSphere ( const Math::WorldBoundSphere & bb, Vector<int> & OUT_instances ) #

Returns the indices of instances inside the bounding sphere.

Notice

The returned list of instance indices is unsorted.

Arguments

const Math::WorldBoundSphere & bb - Bounding sphere defining the area within which instances are to be collected.
Vector<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

true, if there is at least one instance inside the bounding sphere; or false.

Ptr<MeshStatic> getMeshInfo ( ) #

Returns the base mesh that stores data on mesh bounds, surfaces, their number, names, and bounds, but doesn't contain any geometry.

Notice

It's highly recommended NOT to edit the returned mesh.