TextLabelRenderGroup
in package
Table of Contents
Properties
- $fontHandle : string
- The font handle of this group.
- $isStatic : bool
- Wherever this group is static or not.
- $vertexArray : BasicVertexArray
- Simple vertex array to store the transformed character vertices of the entire group.
- $labels : array<string|int, TextLabel>
- The Text labels inside this group
Methods
- __construct() : mixed
- Constructor
- addLabel() : void
- Adds a text label to this group.
- clear() : void
- Removes all text labels from this group.
- getLabels() : array<string|int, TextLabel>
- Returns the text labels in this group.
- markClean() : void
- Mark all labels as clean.
- removeLabel() : void
- Removes a given text label from this group.
- requiresRebuild() : bool
- Requires rebuild Returns true if any of the labels in this group requires a rebuild.
Properties
$fontHandle read-only
The font handle of this group.
public
string
$fontHandle
$isStatic read-only
Wherever this group is static or not.
public
bool
$isStatic
$vertexArray read-only
Simple vertex array to store the transformed character vertices of the entire group.
public
BasicVertexArray
$vertexArray
$labels
The Text labels inside this group
private
array<string|int, TextLabel>
$labels
= []
Methods
__construct()
Constructor
public
__construct(string $fontHandle, bool $isStatic, BasicVertexArray $vertexArray) : mixed
Parameters
- $fontHandle : string
- $isStatic : bool
- $vertexArray : BasicVertexArray
addLabel()
Adds a text label to this group.
public
addLabel(TextLabel $label) : void
Parameters
- $label : TextLabel
clear()
Removes all text labels from this group.
public
clear() : void
getLabels()
Returns the text labels in this group.
public
getLabels() : array<string|int, TextLabel>
Return values
array<string|int, TextLabel>markClean()
Mark all labels as clean.
public
markClean() : void
Keep in mind that the transforms only become clean if the matrix is fetched
removeLabel()
Removes a given text label from this group.
public
removeLabel(TextLabel $label) : void
Parameters
- $label : TextLabel
requiresRebuild()
Requires rebuild Returns true if any of the labels in this group requires a rebuild.
public
requiresRebuild() : bool