Unigine::Field Class

Field Class

Members

---

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

Casts a Field out of the Node instance.

Arguments

• const Ptr<Node> & node - Pointer to Node.

Return value

Pointer to Field.

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.