Jump to content

SceneText class: Difference between revisions

From LabVIEW Wiki
VisualWikitext
Started page
 
m Removed VI Server Category from page
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{VIServerClass|name=SceneText|id=129|scope=basic|class_0=Scene|class_1=SceneDrawable|class_2=SceneText}}
{{VIServerClass|129}}


{{stub}}
{{stub}}
Line 7: Line 7:
{{TOCright}}
{{TOCright}}


==Properties==
<!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates-->
<span class="mw-customtoggle-propertiestable">Show/Hide SceneText Properties Table</span>
{{VIServerClassTables|129}}
<div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
{{VIServerLegend|showrw=TRUE|showrte=TRUE}}
{| class="wikitable sortable"
|+ SceneText Properties Table
! Property ID
! Short Name (English)
! Description
! R/W
! RTE
|- style="background-color:#FFFFCC;"
|C07003
| [[SceneText class/Alignment property|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
|- style="background-color:#FFFFCC;"
|C0700A
| [[SceneText class/HorizontalAlignment property|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
|- style="background-color:#FFFFCC;"
|C07009
| [[SceneText class/VerticalAlignment property|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.
 
<b>Note</b>  The <b>Base Line</b> and <b>Bottom Base Line</b> options behave in the same manner as the <b>Bottom</b> option when you use the default font and the text object includes only one line of text. The <b>Bottom Base Line</b> option behaves in the same manner as the <b>Bottom</b> 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 <b>Base Line</b> and <b>Bottom Base Line</b> behaviors.
|R/W
|X
|- style="background-color:#FFFFCC;"
|C0700B
| [[SceneText class/Axis Alignment property|Axis Alignment]]
|Aligns the text object along the plane you specify.
|R/W
|X
|- style="background-color:#FFFFCC;"
|C07006
| [[SceneText class/CharSize property|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
|- style="background-color:#FFFFCC;"
|C07001
| [[SceneText class/Color property|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
|- style="background-color:#FFFFCC;"
|C07008
| [[SceneText class/FontPath property|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
|- style="background-color:#FFFFCC;"
|C07000
| [[SceneText class/Text property|Text]]
|Specifies the text of a text object.
|R/W
|X
|- style="background-color:#FFFFCC;"
|C07005
| [[SceneText class/Vertical? property|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
|- style="background-color:#FFFFCC;"
|C07007
| [[SceneText class/WrapDistance property|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.
 
<b>Note</b>  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
|}
</div>
 
==Methods==
<span class="mw-customtoggle-methodstable">Show/Hide SceneText Methods Table</span>
<div class="mw-collapsible" id="mw-customcollapsible-methodstable">
{{VIServerLegend|showrte=TRUE}}
{| class="wikitable sortable"
|+ SceneText Methods Table
! Method ID
! Short Name (English)
! Description
! RTE
|- style="background-color:#D1BB80;"
|C06C00
| [[SceneText class/SetFontName method|SetFontName]]
|
|X
|}
</div>
 
==Events==
''No Events for this class.''


== History ==
== History ==
{{ambox|text=History information is needed.  What changes have occured over previous versions?}}
{{ambox|text=History information is needed.  What changes have occurred over previous versions?}}
{| class="wikitable"
{| class="wikitable"
! Version
! Version
Line 128: Line 24:
*[[VI Server]]
*[[VI Server]]


[[Category:VI Server]]
 
[[Category:VI Server Class]]
[[Category:VI Server Class]]

Latest revision as of 01:59, 8 May 2020

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.


This article is a stub. You can help LabVIEW Wiki by expanding it.
Please improve this article if you can.

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

History information is needed. What changes have occurred over previous versions?
Version Change(s)
LabVIEW 2018 More info to come.

See Also

Retrieved from "https://labviewwiki.org/w/index.php?title=SceneText_class&oldid=26640"