Unigine.WorldLayer Class
| Inherits: | Node |
This class describes how to create and modify world layers.
See Also#
A UnigineScript API sample <UnigineSDK>/data/samples/worlds/layer_00
WorldLayer Class
Properties
int NumNodes#
The number of nodes contained in the world layer.
float NodeWeight#
The current priority weight value.
set
Sets the priority weight value. Greater weight means faster node loading inside the same priority group. The default value is 0. Layers with identical groups and weights will be loaded in the alphabetical order.
set value -
New weight value.
int NodeGroup#
The current priority group value. greater priority means faster node loading. the default value is 0.
set
Sets the priority group value. Greater priority means faster node loading. The default value is 0. Layers with identical groups and weights will be loaded in the alphabetical order.
set value -
Priority group value.
string NodeName#
The path to the node.
set
Sets a path to a node.
set value -
Name of the node.
float ClearDistance#
The current clearing distance. starting with this distance, the node wouldn't be loaded in the background.
set
Sets the clearing distance. Starting with this distance, the node wouldn't be loaded in the background. The default is inf.
set value -
Clear distance value, units.
float LoadDistance#
The current loading distance. starting with this distance, the node will be loaded in the background.
set
Sets a new loading distance. Starting with this distance, the node will be loaded in the background. The default is -inf.
set value -
Load distance value, units.
vec3 Offset#
The current offset of coordinates of the layer box center.
set
Sets offset of coordinates of the layer box center.
set value -
Layer box center coordinates.
vec3 Size#
The size of the layer.
set
Updates layer size.
set value -
New size of the layer.
bool IsPoint#
A value indicating if a point mode is set for the layer. the default is 0.
set
Sets a point mode for the layer (its distance is counted from the bounding box center).
set value -
1 to enable Point flag; 0 to disable it.
Members
static WorldLayer ( vec3 size, string name ) #
Constructor. Creates a new layer with the specified parameters.Arguments
- vec3 size - Size of the new layer.
- string name - Name of the new layer.
static WorldLayer Cast ( Node node ) #
Casts a WorldLayer out of the Node instance.Arguments
- Node node - Node instance.
Return value
WorldLayer instance.Node GetNode ( int num ) #
Returns a node pointer.Arguments
- int num - Number of the node in range from 0 to the total number of nodes.
Return value
Node pointer.Node GetNode ( ) #
Returns a node pointer.Return value
Node pointer.static int type ( ) #
Returns the type of the node.Return value
World type identifier.Last update:
2019-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)