Interface IReadOnlyHudElement

Namespace

RichHudFramework.UI

Assembly

RichHudClient.dll

Read-only interface for hud elements with definite size and position.

public interface IReadOnlyHudElement : IReadOnlyHudNode, IReadOnlyHudParent

Inherited Members

Parent

Registered

HudSpace

Visible

InputEnabled

ZOffset

Properties

DimAlignment

Determines how/if an element will copy its parent's dimensions.

DimAlignments DimAlignment { get; }

Property Value

DimAlignments

Height

Height of the element. Units in pixels with HudMain.Root.

float Height { get; }

Property Value

float

IsMousedOver

Indicates whether or not the cursor is currently over the element. The element must be set to capture the cursor for this to work.

bool IsMousedOver { get; }

Property Value

bool

Offset

Position of the center of the UI element relative to its origin.

Vector2 Offset { get; }

Property Value

Vector2

Origin

Starting/anchoring position of the hud element. Starts in the center of the parent node by default. This behavior can be modified with ParentAlignment flags.

Vector2 Origin { get; }

Property Value

Vector2

ParentAlignment

Determines the starting position/anchoring behavior of the hud element relative to its parent.

ParentAlignments ParentAlignment { get; }

Property Value

ParentAlignments

ShareCursor

If set to true the hud element will share the cursor with its child elements.

bool ShareCursor { get; }

Property Value

bool

Size

Size of the element. Units in pixels with HudMain.Root.

Vector2 Size { get; }

Property Value

Vector2

UseCursor

Enables or disables cursor input and capture

bool UseCursor { get; }

Property Value

bool

Width

Width of the element. Units in pixels with HudMain.Root.

float Width { get; }

Property Value

float