Unigine::Plugins::IG::WeatherLayerPrecipitation Class
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to- Sim
SDK edition to use it.
You should upgrade to
Header: | #include <plugins/UnigineIG.h> |
Inherits from: | WeatherLayer |
This class is used to represent a precipitation layer within a weather region. It enables you to define the type of precipitation (rain, snow, etc.), a node (ObjectParticles) to be used to visualize the precipitation effect, and manage the size of particles representing snowflakes or droplets.
WeatherLayerPrecipitation Class
Members
Ptr<Node> getEffectNode ( ) const#
Returns the node used to visualize the precipitation effect.Return value
Node representing the precipitation effect in the world.void setPrecipitationType ( int type ) #
Sets a value defining the type of the weather precipitation layer.Arguments
- int type - Integer value that defines the type of precipitation enabled for the weather layer:
- 0 - disable precipitation
- 1 - rain
- 2 - snow
The set of precipitation types can be extended.
int getPrecipitationType ( ) const#
Returns a value defining the type of the weather precipitation layer.Return value
Integer value that defines the type of precipitation enabled for the weather layer:- 0 - disable precipitation
- 1 - rain
- 2 - snow
The set of precipitation types can be extended.
void setParticlesSize ( float size ) #
Sets the size of particles used to visualize the precipitation effect (snowflakes, droplets, etc.).Arguments
- float size - New particle size, in units.
float getParticlesSize ( ) const#
Returns the current size of particles used to visualize the precipitation effect (snowflakes, droplets, etc.).Return value
Particle size, in units.Last update:
2021-12-13
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)