WorldOccluderMesh Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Inherits:

Node

This class is used to create an occluder based on an arbitrary mesh, which culls surfaces, bounds of which are currently hidden behind it. If any part of the bound of the object's surface is visible behind the occluder, the surface will not be culled. The objects' surfaces behind the occluder are not sent to the GPU, thereby saving performance.

The occluder itself is rendered by the CPU and stored in a separate buffer.

Usage#

In order to enhance performance, occluders should be used wisely. The following notes will help you to decide whether to use the occluder or not:

Occluders can be highly effective in case of complex environments where there are many objects that occlude each other and are costly to render (they have a lot of polygons and/or heavy shaders).
Effective culling is possible if objects are not too large, since if any part of their surface is seen, it cannot be culled. In case objects are big and have a few surfaces, it is likely that an additional performance load of an occluder will not pay off.
In case the scene is filled with flat objects or a camera looks down on the scene from above (for example, in flight simulators), it is better not to use occluders at all or disable them.

Methods:

Name	Description View: Sort by:
WorldOccluderMesh	Constructor.
setDistance	Updates the distance between the camera and the bounding box of the occluder mesh, at which this occluder mesh becomes disabled (it isn't processed by the CPU, hence it isn't rendered).
getDistance	Returns the current distance between the camera and the bounding box of the occluder mesh, at which this occluder mesh becomes disabled (it isn't processed by the CPU, hence it isn't rendered).
setMesh	Allows for reinitialization of the occluder mesh: the function copies a given mesh into the current mesh used for the occluder mesh.
getMesh	Copies the current mesh, on which the occluder mesh is based, into the target mesh.
setMeshName	Sets a new name for the mesh, on which the occluder mesh is based and forces loading of the mesh with the new name for the current occluder mesh.
getMeshName	Returns the name of the mesh, on which the occluder mesh is based.
loadMesh	Loads a mesh for the current occluder mesh from the file.
saveMesh	Saves the mesh, on which the occluder mesh is based, into a file.
type	Returns the type of the node.

WorldOccluderMesh Class

Members

static WorldOccluderMesh ( ) #

Constructor. Creates a new world occluder mesh with the default distance value.

static WorldOccluderMesh ( string name ) #

Constructor. Creates a new world occluder mesh from the given *.mesh file.

Arguments

string name - A mesh file name.

void setDistance ( float distance ) #

Updates the distance between the camera and the bounding box of the occluder mesh, at which this occluder mesh becomes disabled (it isn't processed by the CPU, hence it isn't rendered). By default, the inf value is used.

Arguments

float distance - The distance in units.

float getDistance ( ) #

Returns the current distance between the camera and the bounding box of the occluder mesh, at which this occluder mesh becomes disabled (it isn't processed by the CPU, hence it isn't rendered). By default, the inf value is used.

Return value

The distance in units.

int setMesh ( Mesh mesh ) #

Allows for reinitialization of the occluder mesh: the function copies a given mesh into the current mesh used for the occluder mesh.

Arguments

Mesh mesh - A mesh to be copied.

Return value

1 if the mesh is copied successfully; otherwise, 0.

int getMesh ( Mesh & mesh ) #

Copies the current mesh, on which the occluder mesh is based, into the target mesh.

Arguments

Mesh & mesh - Target mesh.

Return value

1 if the mesh is copied successfully; otherwise, 0.

int setMeshName ( string name, int force_load = 0 ) #

Sets a new name for the mesh, on which the occluder mesh is based and forces loading of the mesh with the new name for the current occluder mesh.

Arguments

string name - A new name to be set for the mesh.
int force_load - Force flag.
- If true (1) is specified, the mesh with the new name will be loaded immediately.
- If false (0) is specified, only the mesh name will be updated.

Return value

true (1) if:

The current mesh name coincides the new name.
The mesh with the new name has been loaded successfully.
The force flag is set to 0.

In other cases, false (0).

string getMeshName ( ) #

Returns the name of the mesh, on which the occluder mesh is based.

Return value

Mesh name.

int loadMesh ( string name ) #

Loads a mesh for the current occluder mesh from the file. This function doesn't change the mesh name.

Arguments

string name - The mesh file name.

Return value

1 if the mesh is loaded successfully; otherwise, 0.

int saveMesh ( string name ) #

Saves the mesh, on which the occluder mesh is based, into a file.

Arguments

string name - The mesh file name.

Return value

1 if the mesh is saved successfully; otherwise, 0.

static int type ( ) #

Returns the type of the node.

Return value

World type identifier.

Last update: 2020-07-31

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

WorldOccluderMesh Class

Usage#

See Also#

Methods:

WorldOccluderMesh Class

Members

static WorldOccluderMesh ( ) #

static WorldOccluderMesh ( string name ) #

Arguments

void setDistance ( float distance ) #

Arguments

float getDistance ( ) #

Return value

int setMesh ( Mesh mesh ) #

Arguments

Return value

int getMesh ( Mesh & mesh ) #

Arguments

Return value

int setMeshName ( string name, int force_load = 0 ) #

Arguments

Return value

string getMeshName ( ) #

Return value

int loadMesh ( string name ) #

Arguments

Return value

int saveMesh ( string name ) #

Arguments

Return value

static int type ( ) #

Return value