Class IconHelper

Namespace: ValveResourceFormat.Renderer.Editor.Helpers
Assembly: Renderer.dll

The icon an entity is placed as: a material drawn at the entity, facing the camera, with a border around it while the entity is selected.

public class IconHelper : EntityHelper

Inheritance

object ← EntityHelper ← IconHelper

Inherited Members

EntityHelper.Owner, EntityHelper.Declaration, EntityHelper.IsVisual, EntityHelper.NeedsShowHelpers, EntityHelper.HiddenInGameObjectsOnly, EntityHelper.RequiresSelection, EntityHelper.IsStandIn, EntityHelper.IsToolShape, EntityHelper.ObjectBounds, EntityHelper.GetObjectBounds(in Matrix4x4), EntityHelper.VisibilityLayerName, EntityHelper.AddToScene(), EntityHelper.GetMetadataColor(string), EntityHelper.GetMetadataFlag(string, bool), EntityHelper.HasArgument(string), EntityHelper.GetColorArguments(int), EntityHelper.Link(), EntityHelper.GetStringKey(string), EntityHelper.GetFloatKey(string, float), EntityHelper.GetBooleanKey(string, bool), EntityHelper.GetIntegerKey(string, int), EntityHelper.GetVector2Key(string), EntityHelper.GetVector3Key(string, Vector3), EntityHelper.GetMetadata(string), EntityHelper.GetArgument(int)

Properties

HiddenInGameObjectsOnly

Gets whether the helper is hidden while only what the game shows is, unless its entity is selected.

public override bool HiddenInGameObjectsOnly { get; }

Property Value

bool

IsStandIn

Gets whether the helper stands in for its entity in the editor, rather than drawing what the game shows of it. The game draws an entity of a compiled map, so of its helpers these are what is drawn in its place.

public override bool IsStandIn { get; }

Property Value

bool

ObjectBounds

Gets the bounds the helper adds to those of its entity in the world, which a selection is boxed by, or null where it adds none. Most helpers add none: a sphere or a line around an entity does not make the entity any larger. An entity none of whose helpers adds any is boxed at its origin.

public override AABB? ObjectBounds { get; }

Property Value

AABB?

Remarks

Only where the icon is placed counts, not the size it is drawn at.

Methods

AddToScene()

Adds what the helper draws to the scene of the entity.

public override void AddToScene()

GetDeclaredMaterialName(HelperDeclaration)

Gets the material a class names in the declaration of an icon.

public static string? GetDeclaredMaterialName(HelperDeclaration declaration)

Parameters

declaration HelperDeclaration

The helper as a class declares it.

Returns

string?

The name of the material, or null when the declaration names none.