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
Core Library
Containers
Engine Classes
Node-Related Classes
Rendering-Related Classes
Physics-Related Classes
Bounds-Related Classes
GUI-Related Classes
Controls-Related Classes
Pathfinding-Related Classes
Utility Classes

Field Class

Interface for field handling.

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

Field Class

Members


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.

Ptr<Field> getField ()

Returns a field pointer.

Return value

The field pointer.

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.

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 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