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
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)