This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
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
CIGI Client Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

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)

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.
Last update: 2018-04-26
Build: ()