SceneText class

VI Server Class Information
Return to VI Server Class Hierarchy
Class Name	class
Class ID	{{{1}}}
Scope
Class Inheritance	This class is a top-level class.
Class Children	This class has no children.

The SceneText class is a class in the VI Server Class Hierarchy, (see also VI Server).

Properties

Show/Hide SceneText Properties Table

Legend
R/W	Readable/Writable Permissions
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

SceneText Properties Table

Property ID	Short Name (English)	Description	R/W	RTE
C07003	Alignment	Specifies the alignment of text in a 3D scene relative to the origin of the text object that contains the text.	R/W	X
C0700A	HorizontalAlignment	Specifies the alignment of a text object in a 3D scene relative to the vertical plane that intersects the center-point of the text object. This property is an element of the Alignment property.	R/W	X
C07009	VerticalAlignment	Specifies the alignment of a text object in a 3D scene relative to the horizontal plane that intersects the center-point of the text object. This property is an element of the Alignment property. Note The Base Line and Bottom Base Line options behave in the same manner as the Bottom option when you use the default font and the text object includes only one line of text. The Bottom Base Line option behaves in the same manner as the Bottom option when you use the default font and the text object includes more than one line of text. You must use a TrueType font to see the expected Base Line and Bottom Base Line behaviors.	R/W	X
C0700B	Axis Alignment	Aligns the text object along the plane you specify.	R/W	X
C07006	CharSize	Specifies the height of text characters in a text object in object coordinates. For example, set character size to 1 to create a text object equal in height to a geometric object with a height of 1.	R/W	X
C07001	Color	Reads or writes the color of the text in a text object in RGBA format. This property accepts a cluster of numeric values 0 through 1, where 0 represents the absence of the red, green, or blue color and 1 represents a full saturation of the color. Elements: Name Description Red - Indicates the saturation of the red color. Valid values include 0 through 1. Green - Indicates the saturation of the green color. Valid values include 0 through 1. Blue - Indicates the saturation of the blue color. Valid values include 0 through 1. Alpha - Indicates the level of transparency of the red, green, and blue colors. Valid values include 0 through 1.	R/W	X
C07008	FontPath	Specifies the path to a font to apply to a text object. This property accepts only TrueType fonts. The path you wire to this property must have a .ttf file extension.	R/W	X
C07000	Text	Specifies the text of a text object.	R/W	X
C07005	Vertical?	Specifies whether LabVIEW renders the text in a text object with the characters arranged vertically or horizontally. If TRUE, LabVIEW arranges the characters vertically, so that the character string aligns with the plane that intersects the center-point of the text object on the x-axis. If FALSE, LabVIEW arranges the characters horizontally, so that the character string aligns with the plane that intersects the center-point of the text object on the y-axis. The default is FALSE.	R/W	X
C07007	WrapDistance	Specifies how much of the text in a text object LabVIEW renders in one line. If you use the Vertical? property to render the text vertically, this property sets the maximum height of the text object. If you render the text horizontally, this property sets the maximum width of the text object. If the length of the text exceeds the wrap distance, LabVIEW wraps the text to a new line. If you set this property to 0, LabVIEW does not wrap the text. Note You cannot use this property to truncate text. If you want to cut off the text, use the Clip Plane:Add Clip Plane to clip the text object.	R/W	X

Methods

Show/Hide SceneText Methods Table

Legend
RTE	Available in the Run-Time Engine
Basic Development Environment
VI Scripting
Private
Deprecated

SceneText Methods Table

Method ID	Short Name (English)	Description	RTE
C06C00	SetFontName		X

Events

No Events for this class.

History

Version	Change(s)
	More info to come.

See Also

• VI Server Class Hierarchy
• VI Server