Table of Contents

Class ParticleModule

Namespace
Stride.Particles
Assembly
Stride.Particles.dll

The ParticleModule is a base class for all plugins (initializers and updaters) used by the emitter Each plugin operates over one or several ParticleFields updating or setting up the particle state Additionally, each plugin can inherit some properties from the parent particle system, which are usually passed by the user.

[DataContract("PaticleModule")]
public abstract class ParticleModule : ParticleTransform
Inheritance
ParticleModule
Derived
Inherited Members

Fields

RequiredFields

A list of fields required by the module to operate properly. Please fill it during construction time.

public List<ParticleFieldDescription> RequiredFields

Field Value

List<ParticleFieldDescription>

Properties

Enabled

Gets or sets a value indicating whether this ParticleModule is enabled.

[DataMember(-10)]
public bool Enabled { get; set; }

Property Value

bool

true if enabled; otherwise, false.

Methods

InvalidateRelations()

Invalidates relation of this emitter to any other emitters that might be referenced

public virtual void InvalidateRelations()

PreUpdate() 

public virtual void PreUpdate()

ResetSimulation()

Resets the current state to the module's initial state

public virtual void ResetSimulation()

SetParentTRS(ParticleTransform, ParticleSystem)

Sets the parent (particle system's) translation, rotation and scale (uniform) The module can choose to inherit, use or ignore any of the elements

public virtual void SetParentTRS(ParticleTransform transform, ParticleSystem parent)

Parameters

transform ParticleTransform

ParticleSystem's transform (from the Transform component) or identity if local space is used

parent ParticleSystem

The parent ParticleSystem

TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3)

Attepmts to get a debug shape (shape type and location matrix) for the current module in order to display its boundaries better

public virtual bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale)

Parameters

debugDrawShape DebugDrawShape

Type of the debug draw shape

translation Vector3

Translation of the shape

rotation Quaternion

Rotation of the shape

scale Vector3

Scaling of the shape

Returns

bool
Edit this page