 |
InstancedText Class |
InstancedText object is returned from the InstancedTextNode.AddText method and can be used to change the text's position, color, show or hide the text.
The class also defines the size of the 3D text.
Inheritance HierarchySystemObject
Ab4d.SharpEngine.CommonInstancedText
Namespace: Ab4d.SharpEngine.CommonAssembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.2.9386+3a404a3e1ebfa4efd231da7fe6f10dfb23b95dc4
Syntaxpublic class InstancedText
The InstancedText type exposes the following members.
Properties| | Name | Description |
|---|
 | Color |
Gets the color of the text
|
 | FontSize | |
 | HasBackSide |
Gets Boolean that specifies if back side texture is rendered for this text (if the text is also visible from the back side)
|
 | IsVisible |
Gets a Boolean that specifies if the text is visible.
|
 | NormalDirection | |
 | Position | |
 | Text |
Gets the text
|
 | TextDirection | |
 | TextOffset |
Gets a Vector2 that defines how much the text (and TextSize) is offset from the TopLeftPosition.
This is usually (0, 0), but when the text begins before the start position the X position is negative.
Also, when the text extend above the baseline height (for example 'Ö' or 'Č') then the Y position is negative.
|
 | TextSize |
Gets a Vector2 that define the approximate size of the text in 3D space.
The actual size may be bigger because some characters may extend above or below the baseline (like 'Ö', 'Č', 'g', 'y', 'p', etc.).
See also the TextOffset that defines how much the text is offset from the TopLeftPosition.
|
 | UpDirection | |
Top
Methods| | Name | Description |
|---|
 | GetBoundingBox |
Returns the bounding box of this InstancedText object.
|
 | Hide |
Hides the text
|
 | Move |
Moves the text for the specified moveVector
|
 | SetColor |
Sets the color of the text.
|
 | SetFontSize |
Changes the font size
|
 | SetOrientation |
Sets the Orientation of the text by providing the text direction and up direction (directions are normalized inside the method).
This method calculates the normalDirection from the textDirection and upDirection.
The text size is calculated from the existing WorldMatrix.
|
 | SetPosition |
Sets the position of the text
|
 | SetText |
Changes the text of this InstancedText to the new text.
|
 | Show |
Shows the text
|
 | ToString | (Overrides ObjectToString) |
Top
See Also