Class WireframeSceneNode

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

Base for scene nodes that draw a static colored line list, such as visibility clusters, navigation volumes or entity connection lines.

public abstract class WireframeSceneNode : SceneNode

Inheritance

object ← SceneNode ← WireframeSceneNode

Derived

LineSceneNode, NavSpaceSceneNode, VisibilitySceneNode

Inherited Members

SceneNode.Tint, SceneNode.Alpha, SceneNode.TintAlpha, SceneNode.Transform, SceneNode.LayerName, SceneNode.LayerEnabled, SceneNode.Visible, SceneNode.BoundingBox, SceneNode.LocalBoundingBox, SceneNode.Name, SceneNode.Id, SceneNode.IsSelected, SceneNode.IsPointMarker, SceneNode.Flags, SceneNode.AdditionalFlags, SceneNode.RenderPasses, SceneNode.UpdateBuffers(Camera), SceneNode.Scene, SceneNode.KeepsMarkerSize, SceneNode.Parent, SceneNode.Children, SceneNode.ParentAttachment, SceneNode.LocalTransform, SceneNode.SetParent(SceneNode?, string?, Matrix4x4?), SceneNode.GetChildFrame(string?), SceneNode.UpdateHierarchy(Scene.UpdateContext), SceneNode.GetRigidTransform(Matrix4x4), 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

WireframeSceneNode(Scene, string)

Initializes a new WireframeSceneNode. The lines are built when the node is first drawn.

protected WireframeSceneNode(Scene scene, string debugName)

Parameters

scene Scene

debugName string

Properties

IsTranslucent

Gets whether the lines draw in the translucent pass without depth writes, or in the opaque pass with the pass depth state.

protected virtual bool IsTranslucent { get; }

Property Value

bool

VertexCount

Gets the number of line vertices uploaded to the GPU.

protected int VertexCount { get; }

Property Value

int

Methods

BuildLines()

Builds the line list, two vertices per line. Called once, when the node is first drawn.

protected abstract List<SimpleVertex> BuildLines()

Returns

List<SimpleVertex>

Delete()

Releases resources held by this node.

public override void Delete()

DrawLines(RenderContext)

Issues the line draws. Draws every line by default.

protected virtual void DrawLines(Scene.RenderContext context)

Parameters

context Scene.RenderContext

DrawLines(int, int)

Draws a range of the uploaded line vertices.

protected void DrawLines(int start, int count)

Parameters

start int

count int

GetIdColor(uint)

Gets a stable, mid-brightness color for an id, so neighbouring clusters are told apart.

public static Color32 GetIdColor(uint id)

Parameters

id uint

Returns

Color32

Render(RenderContext)

Called each frame to render this node.

public override void Render(Scene.RenderContext context)

Parameters

context Scene.RenderContext

The current render context.