Programming
Fundamentals
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
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes

Unigine::Field Class

Header:#include <UnigineFields.h>
Inherits:Node

This class allows you to modify fields masks.

Field Class

Members


Ptr<Field> cast(const Ptr<Node> & node)

Arguments

  • const Ptr<Node> & node

Ptr<Field> getField()

Returns a field pointer.

Return value

The field pointer.

void setFieldMask(int mask)

Sets a field mask specifying the area of the Field node to be applied. The object will be influenced by the field if they both have matching masks.

Arguments

  • int mask - An integer value, each bit of which is used to set a mask.

int getFieldMask()

Returns the mask specifying the area of the Field node to be applied. The object will be influenced by the field if they both have matching masks.

Return value

The integer value, each bit of which is used to set a mask.

void setViewportMask(int mask)

Sets a bit mask for rendering the Field node into the viewport.

Arguments

  • int mask - An integer value, each bit of which is used to set a mask.

int getViewportMask()

Returns the current bit mask for rendering the Field node into the viewport.

Return value

The integer value, each bit of which is used to set a mask.
Last update: 2017-07-03