Class ParticleSceneNode

Namespace: ValveResourceFormat.Renderer.SceneNodes
Assembly: Renderer.dll

Scene node that renders particle system effects.

public class ParticleSceneNode : SceneNode

Inheritance

object ← SceneNode ← ParticleSceneNode

Inherited Members

SceneNode.Transform, SceneNode.LayerName, SceneNode.LayerEnabled, SceneNode.BoundingBox, SceneNode.LocalBoundingBox, SceneNode.Name, SceneNode.Id, SceneNode.IsSelected, SceneNode.Flags, SceneNode.Scene, SceneNode.EnvMaps, SceneNode.ShaderEnvMapVisibility, SceneNode.LightingOrigin, SceneNode.OverlayRenderOrder, SceneNode.CubeMapPrecomputedHandshake, SceneNode.LightProbeVolumePrecomputedHandshake, SceneNode.LightProbeBinding, SceneNode.EntityData, SceneNode.Update(Scene.UpdateContext), SceneNode.Render(Scene.RenderContext), SceneNode.GetSupportedRenderModes(), SceneNode.SetRenderMode(string), SceneNode.Delete(), SceneNode.GetCameraDistance(Camera)

Constructors

ParticleSceneNode(Scene, ParticleSystem, ParticleSnapshot?, bool)

Initializes a new instance of the class.

public ParticleSceneNode(Scene scene, ParticleSystem particleSystem, ParticleSnapshot? particleSnapshot = null, bool preview = false)

Parameters

scene Scene

The scene this node belongs to.

particleSystem ParticleSystem

The particle system resource to simulate and render.

particleSnapshot ParticleSnapshot?

Optional snapshot to provide initial particle data (e.g. from a map entity).

preview bool

Whether to load preview control point state. And loop playback when finished.

Properties

FrametimeMultiplier

Gets or sets a time-scale multiplier applied to the particle simulation each frame.

public float FrametimeMultiplier { get; set; }

Property Value

float

Preview

Whether to load preview control point state. And loop playback when finished.

public bool Preview { get; set; }

Property Value

bool

PreviewModel

Gets the preview model scene node loaded from particle preview state, if any.

public ModelSceneNode? PreviewModel { get; }

Property Value

ModelSceneNode?

Methods

Delete()

Releases resources held by this node.

public override void Delete()

GetControlPoint(int)

public ControlPoint GetControlPoint(int index)

Parameters

index int

Returns

ControlPoint

GetSupportedRenderModes()

Returns the render modes supported by this node.

public override IEnumerable<string> GetSupportedRenderModes()

Returns

IEnumerable<string>

Render(RenderContext)

Called each frame to render this node.

public override void Render(Scene.RenderContext context)

Parameters

context Scene.RenderContext

The current render context.

Restart()

Restarts the particle system from the beginning.

public void Restart()

SetRenderMode(string)

Sets the active render mode for this node.

public override void SetRenderMode(string mode)

Parameters

mode string

The render mode name to activate.

Update(UpdateContext)

Called each frame to update this node's state.

public override void Update(Scene.UpdateContext context)

Parameters

context Scene.UpdateContext

The current update context.