ScreenGizmo

Description

sealed class Tinman.Engine.Scenes.Entities.ScreenGizmo

Derived from

SceneEntityView<ISceneView> abstract

Renders a IScreenLabel as a separate overlay onto the screen.

No additional screen label logic will be performed, it will only be rendered.

The ISceneEntityView.QueryScreen method generates a ScreenLabelResult for screen gizmo screen label.

Public / Constructors

ScreenGizmo


public constructor ScreenGizmo → (1)

gizmo opt : IScreenLabel = null

Initial value for Gizmo.

Creates a new instance of ScreenGizmo.

Public / Attributes

Gizmo


public attribute Gizmo → (get,set)

value : IScreenLabel

The screen label or null for none.

The screen label to render as an overlay gizmo.

If the screen label gizmo implements the following methods, the ScreenGizmo will call them automatically:

Defaults to null.

Occluded


public attribute Occluded → (get,set)

value : bool

true to render the screen label as occluded, false to do not.

Render the screen label as occluded?

Defaults to false.

Occupy


public attribute Occupy → (get,set)

value : bool

true to mark the gizmo bounds as occupied via ScreenLabelPlacement.Occupied, false to not mark the gizmo bounds.

Mark the screen gizmo bounds as occupied?

Defaults to false.

Offset


public attribute Offset → (get,set)

value : Vec2I

The position offset, in screen pixels.

The position offset to use for rendering the screen gizmo.

Defaults to Vec2I.Zero.

Position


public attribute Position → (get,set)

value : Anchor

The relative screen position.

The relative position of the gizmo on the screen.

Defaults to Anchor.Center.