ScreenLabelPlacement

Description

sealed class Tinman.Engine.Drawing.ScreenLabelPlacement

Helper object for placing rectangular labels on a screen viewport while avoiding overlaps.

public constructor ScreenLabelPlacement → ()

Creates a new instance of ScreenLabelPlacement.

public method Add → (5)

label ⁱⁿ : IScreenLabel: [not-null]
The screen label object.
bounds ⁱⁿ : Box2I: The screen bounds.
offset ^opt : Vec2F = default(Vec2F): Optional sub-pixel offset.
depth ^opt : float32 = 0: The screen depth (see Graphics.PushDepth).
priority ^opt : int32 = 0: Optional priority. Labels with lower priority will be hidden if necessary to avoid overlaps.
returns → int32: The ordinal that can be used to identify the added screen label later.

Adds a screen label.

public method Clear → ()

Removes all screen labels.

[Pure]
public method Get → (1)

ordinal ⁱⁿ : int32: The screen label ordinal, as returned by Add.
returns → ScreenLabelPlacementEntry: The placement information of the screen label or ScreenLabelPlacementEntry.None if ordinal ⁱⁿ is invalid.

Returns the placement information of a screen label.

public method Occluded → (1)

Checks if a screen label has been drawn as occluded during the last call to Render.

public method Occupied → (1)

bounds ⁱⁿ : Box2I: The screen rectangle to add.
returns → bool: true if bounds ⁱⁿ intersects with the occupied region, false if it does not.

Manually adds the given rectangle to the occupied screen region if it does not intersect with it.

public method Render → ()

Renders the screen labels while avoiding overlaps.

public attribute Debug → (get,set)

Enable visual debug helpers?

When set to true, the bounds of screen labels are shown as pink bars. Occluded screen labels are shown as pink rectangles.

public attribute Size → (get,set)

The screen size.