Programming
Fundamentials
Setting Up Development Environment
UnigineScript
High-Level Systems
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Bounds-Related Classes
Containers
Controls-Related Classes
Core Library
Engine-Related Classes
GUI-Related Classes
Node-Related Classes
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes
Utility Classes

WorldSwitcher Class

Interface for world switcher handling. See also the UnigineScript analog.

To use this class, include the UnigineWorldSwitcher.h file.

WorldSwitcher Class

Members


WorldSwitcher (const Math::vec3 & size)

Creates a switcher for child nodes.

Arguments

  • const Math::vec3 & size - Box dimensions in units.

void setOffset (const Math::vec3 & offset)

Sets offset of coordinates of the switcher box center.

Arguments

  • const Math::vec3 & offset - Offset of coordinates.

Math::vec3 getOffset ()

Returns the currnt offset of coordinates of the switcher box center.

Return value

Current offset of coordinates.

void setMinDistance (float distance)

Sets the minimum distance of visibility. If a camera is closer to a node than this minimum distance, a node is not visible. The default is -inf.

Arguments

  • float distance - Minimum distance of visibility in units.

float getMinDistance ()

Returns the current minimum distance of visibility. If a camera is closer to a node than this minimum distance, a node is not visible. The default is -inf.

Return value

Minimum distance of visibility in units.

void setPoint (int point)

Sets a point mode for the switcher. If the point mode is set, the distance is measured to the bounding box center; otherwise, to the bounding box edges.

Arguments

  • int point - 1 to set the point mode, 0 not to set.

int isPoint ()

Returns a value indicating if the point mode is set for the switcher. If the point mode is set, the distance is measured to the bounding box center; otherwise, to the bounding box edges.

Return value

Returns 1 if the point mode is set; otherwise, 0.

void setMaxDistance (float distance)

Sets the maximum distance of visibility. If a camera is further from a node than this maximum distance, a node is not visible. The default is inf.

Arguments

  • float distance - Maximum distance of visibility in units.

float getMaxDistance ()

Returns the current maximum distance of visibility. If a camera is further from a node than this maximum distance, a node is not visible. The default is inf.

Return value

Maximum distance of visibility in units.

Math::vec3 getSize ()

Returns the current size of a switcher.

Return value

Current switcher size (i.e. box dimensions in units).

void setSize (const Math::vec3 & size)

Sets the size of a switcher.

Arguments

  • const Math::vec3 & size - New switcher size (i.e. box dimensions in units).
Last update: 2017-07-03