This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

WorldSwitcher Class

Warning
The 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 allows switching off (and turn on) big parts of the world at once. A switcher is made a parent for nodes it controls. It is of a box shape, and the distance from the camera can be measured to its edges or to its center.

See Also#

A set of UnigineScript API samples located in the <UnigineSDK>/data/samples/worlds/ folder:

  • switcher_00
  • switcher_01

WorldSwitcher Class

Members


static WorldSwitcher ( ) #

Constructor. Creates a world switcher.

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.

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.

Return value

Maximum distance of visibility in units.

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.

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.

Return value

Minimum distance of visibility in units.

static int type ( ) #

Last update: 2020-07-31
Build: ()