Class ViewportIconsRenderer

Editor viewports icons rendering service.

Inheritance

ViewportIconsRenderer

Assembly: FlaxEngine.dll

File: Editor/Utilities/ViewportIconsRenderer.h

Syntax

public class ViewportIconsRenderer

Methods

AddActor(Actor* actor)

Adds actor to the viewport icon rendering.

Declaration

public static void AddActor(Actor* actor)

Parameters

Actor actor The actor to register for icon drawing.

AddActorWithTexture(Actor* actor, Texture* iconTexture)

Adds actor to the viewport icon rendering.

Declaration

public static void AddActorWithTexture(Actor* actor, Texture* iconTexture)

Parameters

Actor actor The actor to register for icon drawing.

Texture iconTexture The icon texture to draw.

AddCustomIcon(const ScriptingTypeHandle& type, Texture* iconTexture)

Adds icon to the custom actor.

Declaration

public static void AddCustomIcon(const ScriptingTypeHandle& type, Texture* iconTexture)

Parameters

ScriptingTypeHandle type The actor type.

Texture iconTexture The icon texture to draw.

DrawIcons(RenderContext& renderContext, Actor* actor)

Draws the icons for the actors in the given scene (or actor tree).

Declaration

public static void DrawIcons(RenderContext& renderContext, Actor* actor)

Parameters

RenderContext renderContext The rendering context.

Actor actor The actor (use scene for faster rendering).

RemoveActor(Actor* actor)

Removes actor from the viewport icon rendering.

Declaration

public static void RemoveActor(Actor* actor)

Parameters

Actor actor The actor to unregister for icon drawing.