This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Basics
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
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::ParticlesFieldSpacer Class

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

This class represents a spacer for particles generated by Particle Systems. Spacer — is a volumetric field that has no visual representation, but physically interacts with particle systems (other objects are not affected). This field is used to cut particles out from a certain volume (particles it comes in contact with), for example, to avoid rendering of rain inside a car. It can have a box, cylinder, capsule, sphere, or ellipse shape, size, and can be arbitrarily positioned or rotated to cover the necessary area.

ParticlesFieldSpacer Class

Enums

SHAPE_TYPE#

Shape types of the Particles Field Spacer.
NameDescription
SHAPE_TYPE_BOX = 0Box shape.
SHAPE_TYPE_CYLINDER = 1Cylinder shape.
SHAPE_TYPE_CAPSULE = 2Capsule shape.
SHAPE_TYPE_SPHERE = 3Sphere shape.
SHAPE_TYPE_ELLIPSE = 4Ellipse shape.
NUM_SHAPE_TYPES = 5Number of shape types for the Particles Field Spacer.

Members


ParticlesFieldSpacer ( ) #

Constructor. Creates a new Particles Field Spacer with default parameters.

ParticlesFieldSpacer ( const Math::vec3 & size ) #

Constructor. Creates a new box-shaped Particles Field Spacer of the specified size.

Arguments

  • const Math::vec3 & size - Size of the Particles Field Spacer along the X, Y, and Z axes to be set, in units. In case the spacer has an ellipse shape, each component of the vector sets a radius along the corresponding axis.

static int type ( ) #

Returns the type of the Particles Field Spacer node.

Return value

ParticlesFieldSpacer type identifier.

void setShapeType ( ParticlesFieldSpacer::SHAPE_TYPE type ) #

Sets a new shape for the Particles Field Spacer.

Arguments

ParticlesFieldSpacer::SHAPE_TYPE getShapeType ( ) const#

Returns the current shape of the Particles Field Spacer.

Return value

Current shape type of the Particles Field Spacer. One of the SHAPE_TYPE* values.

void setSize ( const Math::vec3 & size ) #

Sets a new size for the Particles Field Spacer.

Arguments

  • const Math::vec3 & size - New size of the Particles Field Spacer along the X, Y, and Z axes to be set, in units. In case the spacer has an ellipse shape, each component of the vector sets a radius along the corresponding axis.

Math::vec3 getSize ( ) const#

Returns the size of the Particles Field Spacer

Return value

Current size of the Particles Field Spacer along the X, Y, and Z axes, in units. In case the spacer has an ellipse shape, each component of the vector sets a radius along the corresponding axis.

void setRadius ( float radius ) #

Sets a new radius for the Particles Field Spacer.

Arguments

  • float radius - New radius to be set for the Particles Field Spacer, in units.

float getRadius ( ) const#

Returns the current radius of the Particles Field Spacer.

Return value

Current radius of the Particles Field Spacer, in units.

void setHeight ( float height ) #

Sets a new height value for the Particles Field Spacer.

Arguments

  • float height - New height value to be set for the Particles Field Spacer, in units.

float getHeight ( ) const#

Returns the current height of the Particles Field Spacer.

Return value

Current height of the Particles Field Spacer, in units.
Last update: 2024-04-19
Build: ()