UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
Usage Examples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

Unigine::Field Class

Interface for field handling.

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

Unigine::Field Class

Members


static Ptr< Field > create (const NodePtr & node)

Field constructor.

Arguments

  • const NodePtr & node - Node smart pointer.

virtual Ptr< Field > getField () const =0

Returns a field pointer.

Return value

The field pointer.

virtual void setFieldMask (int mask) const =0

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.

virtual int getFieldMask () const =0

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.

virtual void setViewportMask (int mask) const =0

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.

virtual int getViewportMask () const =0

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