This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
VR Development
Double Precision Coordinates
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
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 from: Node

This class allows you to modify fields masks.

Field Class

Members


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 ( ) const#

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 ( ) const#

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: 2023-12-19
Build: ()