Getting Started
Migrating to UNIGINE 2.0
C++ API Migration
UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins

WorldOccluderMesh Class

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.

See Also

WorldOccluderMesh Class

This class inherits from Node

Members


WorldOccluderMesh ()

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

WorldOccluderMesh (string name)

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

Arguments

  • string name - A mesh file name.

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.

string getMeshName ()

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

Return value

The mesh name.

int getMesh (Mesh mesh)

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

Arguments

  • Mesh mesh - The mesh.

Return value

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

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.

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.

void setMeshName (string name)

Sets a new name for the mesh, on which the occluder mesh is based.

Arguments

  • string name - A name to be set for the mesh.

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.
Last update: 2017-07-03