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.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 type - New shape type to be set for the Particles Field Spacer. One of the SHAPE_TYPE* values.
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 SpacerReturn 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:
2023-06-23
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)