Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ XR Studio

Configuring Parameters for Rain

  • Last UpdatedMar 03, 2023
  • 2 minute read

Configuring the parameters and attributes for Rain Particles Renderer effect.

Parameter

Type

Limits

Description

Xparam

emitterPosition

FLOAT3

Emitter position. Used when followRenderCamera is False.

x

enabled

BOOL

Enable/disable, show/hide the rain effect

x

followRenderCamera

BOOL

The emitter position moves each frame to match the camera that is used for rendering.

x

forcesMultiplier

FLOAT

[0..inf]

Scales all the forces in the simulation.

Can be used while tweaking forces.

Resets the simulation.

x

frameZeroAutoPopulate

BOOL

Populates the simulation with random particles on the first simulation frame. Without this, particles start from a simulated position, which may result in an empty screen until the particles fall.

Resets the simulation.

x

frameZeroYRange

FLOAT

[0..inf]

The Y range in which particles spawn if frameZeroAutoPopulate is True.

This is relative to the emitter position.

Resets the simulation.

x

gravity

FLOAT3

Gravity (or main force).

x

heightMap

NODE

HeightMap params.

yDrain and heightMap nodes cannot be used simultaneously.

maxParticles

INT

[1..inf]

Max number of particles available for the simulation.

Do not change at runtime.

Resets the simulation.

x

name

STRING

Identifier of this particles renderer.

numParticles

INT

[0..inf]

Number of particles processed and rendered.

Must be less (or equal) than maxParticles.

x

opacity

FLOAT

[0..1]

Pixel opacity

x

particleWidth

FLOAT

[0..inf]

Width of the rendered particles

x

particleYAspect

FLOAT

[0..inf]

Y aspect ratio of the rendered particles (Y= Width x YAspect)

x

randomForceRange

FLOAT3

Additional force added randomly to each particle.

X and Z component have a random range from -range to +range.

Y component have a random range between 0 and range.

Resets the simulation.

x

shrinkMinValue

FLOAT

[0..inf]

Minimum shrink value that the particles can have, which prevents them from disappearing.

Particles are shrunk when viewed from the direction of the camera. This way, when looking up or down, the particles look less wide.

0 is full shrink.

1 is no shrink.

x

spawnRadius

FLOAT

[0..inf]

Particles spawn radius (X and Z components)

x

spawnY

FLOAT

Particles spawn Y (relative to the emitter position, Y= emitY + spawnY)

x

spawnYRandomRange

FLOAT

Particles spawn range on the Y axis

x

texture

NODE

Rendering texture parameters

type

STRING

Rain

Must be Rain.

version

INT

1

Must be 1.

wind

FLOAT3

Additional force

x

yDrain

FLOAT

The Y value at which the particles die.

yDrain and heightMap nodes cannot be used simultaneously.

x

TitleResults for “How to create a CRG?”Also Available in