Class SkeletonSceneNode

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

Scene node that visualizes skeletal bone hierarchy, animation poses and model attachments.

public class SkeletonSceneNode : SceneNode

Inheritance

object ← SceneNode ← SkeletonSceneNode

Inherited Members

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

Constructors

SkeletonSceneNode(Scene, Matrix4x4[], Skeleton, IReadOnlyDictionary<string, Attachment>?)

Initializes a new instance of the class.

public SkeletonSceneNode(Scene scene, Matrix4x4[] pose, Skeleton skeleton, IReadOnlyDictionary<string, Attachment>? attachments = null)

Parameters

scene Scene

The scene this node belongs to.

pose Matrix4x4[]

The world-space bone pose to visualize, indexed by bone index.

skeleton Skeleton

The skeleton definition containing bone hierarchy.

attachments IReadOnlyDictionary<string, Attachment>?

Model attachments that can be visualized, or null.

Properties

Enabled

Whether the node has anything to draw.

public bool Enabled { get; }

Property Value

bool

SelectedAttachments

Names of the attachments to draw when is set.

public HashSet<string> SelectedAttachments { get; }

Property Value

HashSet<string>

ShowAttachments

Gets or sets whether the attachment visualization is drawn.

public bool ShowAttachments { get; set; }

Property Value

bool

ShowBones

Gets or sets whether the bone hierarchy is drawn.

public bool ShowBones { get; set; }

Property Value

bool

Methods

Delete()

Releases resources held by this node.

public override void Delete()

Render(RenderContext)

Called each frame to render this node.

public override void Render(Scene.RenderContext context)

Parameters

context Scene.RenderContext

The current render context.

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.