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
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::ParticlesField Class

Header: #include <UnigineParticlesFields.h>
Inherits from: Node

This is a base class for all Particles Fields and incorporates their common characteristics. ParticlesFieldSpacer and ParticlesFieldDeflector classes derive from it.

Particles Fields can be used to cut particles out from a certain volume (spacer-fields that can be used, for example, to avoid rendering of rain inside a car) or to deflect particles making them bounce from the field's surface (deflector).

A Particles Fields will affect a Particles System only if they interact with each other. You can control interaction of fields and particles via a separate mask (Particles Field). You can also switch between interaction modes to choose if particles should interact on a contact of the field either with particle's center position or with its bounding box.

ParticlesField Class

Enums

INTERACT_PARTICLE_MODE#

Interaction modes for the Particles Field.
NameDescription
INTERACT_PARTICLE_MODE_POSITION = 0Position mode. Interaction between the Particles Field and a particle takes place if the position of the particle's center comes into contact (intersection) with the field (its volume or surface in case of a deflector field).
INTERACT_PARTICLE_MODE_BOUND = 1Bound mode. Interaction between the Particles Field and a particle takes place if the bounding box of the particle comes into contact (intersection) with the field (its volume or surface in case of a deflector field).
NUM_INTERACT_PARTICLE_MODES = 2Number of interaction modes for Particles Fields.

Members


void setInteractParticleMode ( ParticlesField::INTERACT_PARTICLE_MODE mode ) #

Sets a new interaction mode for the Particles Field. Interaction can be triggered on a contact of the field either with particle's center position or with its bounding box.

Arguments

ParticlesField::INTERACT_PARTICLE_MODE getInteractParticleMode ( ) const#

Returns the current interaction mode for the Particles Field. Interaction can be triggered on a contact of the field either with particle's center position or with its bounding box.

Return value

Current interaction mode of the Particles Field. One of the INTERACT_PARTICLE_MODE* values.

void setParticlesFieldMask ( int mask ) #

Sets a new Particles Field bit mask enabling you to control interactions with particles. The Particles Field will interact with a Particles System if they both have matching Particles Field masks (one bit at least).

Arguments

  • int mask - New mask to be set for the field. Integer, each bit of which is a mask.

int getParticlesFieldMask ( ) const#

Returns the current Particles Field bit mask enabling you to control interactions with particles. The Particles Field will interact with a Particles System if they both have matching Particles Field masks (one bit at least).

Return value

Current mask of the field. Integer, each bit of which is a mask.

void setViewportMask ( int mask ) #

Sets a new Viewport mask enabling you to control rendering of the field. The Particles Field will be rendered in the viewport if it has a matching Viewport mask (one bit at least).

Arguments

  • int mask - New Viewport mask to be set for the field. Integer, each bit of which is a mask.

int getViewportMask ( ) const#

Returns the current Viewport mask enabling you to control rendering of the field. The Particles Field will be rendered in the viewport if it has a matching Viewport mask (one bit at least).

Return value

Current Viewport mask of the field. Integer, each bit of which is a mask.
Last update: 2023-12-19
Build: ()