Click or drag to resize
Ab4d.SharpEngine logo

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 Hierarchy
SystemObject
  Ab4d.SharpEngine.CommonInstancedText

Namespace: Ab4d.SharpEngine.Common
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 3.1.9316+94bbd23b55747f096f056a5602f7dd90558b3673
Syntax
C#
Copy
public class InstancedText

The InstancedText type exposes the following members.

Properties
 NameDescription
Public propertyColor Gets the color of the text
Public propertyFontSize 
Public propertyHasBackSide Gets Boolean that specifies if back side texture is rendered for this text (if the text is also visible from the back side)
Public propertyIsVisible Gets a Boolean that specifies if the text is visible.
Public propertyNormalDirection 
Public propertyPosition 
Public propertyText Gets the text
Public propertyTextDirection 
Public propertyTextOffset 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.
Public propertyTextSize 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.
Public propertyUpDirection 
Top
Methods
 NameDescription
Public methodGetBoundingBox Returns the bounding box of this InstancedText object.
Public methodHide Hides the text
Public methodMove Moves the text for the specified moveVector
Public methodSetColor Sets the color of the text.
Public methodSetFontSize Changes the font size
Public methodSetOrientation 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.
Public methodSetPosition Sets the position of the text
Public methodSetText Changes the text of this InstancedText to the new text.
Public methodShow Shows the text
Public methodToString
(Overrides ObjectToString)
Top
Remarks

[Missing <remarks> documentation for "T:Ab4d.SharpEngine.Common.InstancedText"]

See Also