Jump to content

SceneText class

From LabVIEW Wiki
VI Server Class Information
Return to VI Server Class Hierarchy
Class Name SceneText class
Class ID 129
Scope Basic Development Environment
Class Inheritance
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/WReadable/Writable Permissions
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    SceneText Properties Table
    Property ID Long Name (English) Description R/W RTE
    C07000TextSpecifies the text of a text object.Read/WriteYes
    C07001ColorReads 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.Read/WriteYes
    C07003AlignmentSpecifies the alignment of text in a 3D scene relative to the origin of the text object that contains the text.Read/WriteYes
    C07005Vertical?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.Read/WriteYes
    C07006Character SizeSpecifies 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.Read/WriteYes
    C07007Wrap DistanceSpecifies 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.Read/WriteYes
    C07008Font PathSpecifies 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.Read/WriteYes
    C07009Alignment:VerticalSpecifies 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.Read/WriteYes
    C0700AAlignment:HorizontalSpecifies 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.Read/WriteYes
    C0700BAxis AlignmentAligns the text object along the plane you specify.Read/WriteYes

    Methods

    Show/Hide SceneText Properties Table

    Legend
    RTEAvailable in the Run-Time Engine
    Basic Development Environment
    VI Scripting
    Private
    Deprecated
    SceneText Methods Table
    Method ID Long Name (English) Description RTE
    C06C00Set Font by NameYes

    Events

    This class has no events or it inherits events from its parent: SceneDrawable Class.


    History

    Version Change(s)
    LabVIEW 2018 More info to come.

    See Also