TextString, TextString3D

Synopsis

Define a renderable 2D or 3D text string in annotation or stroke text style

Parameters

str	UItext
font	UItext
align_horiz	UIoptionMenu
align_vert	UIoptionMenu
drop_shadow	UItoggle
bounds	UItoggle
underline	UItoggle
background	UItoggle
leadline	UItoggle
radial	UItoggle
do_offset	UItoggle
offset	UIfield

Parameters (for stroke text only)

font_type	UIoptionMenu
plane	UIoptionMenu
orient	UIoptionMenu
angle	UIslider
path	UIoptionMenu
space_mode	UIoptionMenu
spacing	UIslider
height	UIslider
expansion	UIslider

Output Ports

DefaultObject

DefaultObject

Description

TextString and TextString3D define 2D and 3D renderable text strings that have a user interface to control many of the text attributes.

Parameters

str

UItext. Contains the string to be rendered.

font

UItext. Contains the font that the string is rendered with. The font is connected to the properties' font subobject. Not available if you have selected Stroke Text; use the font_type parameter to set the font for stroke text.

align_horiz (int)

UIoptionMenu. This controls the horizontal alignment of the text string with respect to a certain point : 0 means left align the text to the specified point; 1 means cente ralign the text to the specified point; 2 means right align the text to the specified point.

align_vert (int)

UIoptionMenu. This controls the vertical alignment of the text string with respect to a certain point: 0 means base; 1 means bottom of the text; 2 means center of the text; 3 means the top of the text.

drop_shadow

UItoggle. This controls if a drop shadow is rendered: unset means no; set means yes. Not available for Stroke Text.

bounds

UItoggle. This controls if a bounding box is rendered around the text string: unset means no; set means yes.

underline

UItoggle. This controls if the text string is underlined: unset means no; set means yes.

background

UItoggle. This controls if a background is rendered in the view's background color: unset means no; set means yes.

lead_line

UItoggle. This controls if a line is rendered from the text position to the position where the text is rendered: unset means no; set means yes. The position that the text is rendered at is the text position plus the offset if it is enabled. Not available for Stroke Text.

radial

UItoggle. This automatically displays the text aligned and offset away from the center of the view: unset means no; set means yes.If radial is set, the align_horiz parameter is overriden. Instead, alignment works in the following manner. If the text X position is to the left of center, the text string is right aligned. If the text X position is to the right of center, the text string is left aligned.The offset is used when the do_offset parameter is set but it is used in a different manner. The radius of the offset is used to position the text away from the center. In the upper right quadrant, this is towards the upper right. In the lower right quadrant, this is towards the lower right. In the upper left quadrant, this is towards the upper left. In the lower left quadrant, this is towards the lower left.

do_offset

UItoggle. This controls if the offset is to be added to the text position prior to rendering: unset means no; set means yes.

offset

This parameter is an NDC offset that is added to the text position prior to rendering. Default values are: X offset is 0.05; Y offset is 0.05; Z offset is 0.0. The do_offset paramter controls whether the offset is used.

Parameters (for stroke text only)

font_type

UIoptionMenu. This controls the type of font displayed. Possible options are:

Roman simplex	Script simplex	Italic complex	Greek simplex
Roman duplex	Script complex	Italic triplex	Greek complex
Roman complex
Roman triplex

plane

UIoptionMenu. Used in conjunction with the orient and angle subobjects, specifies the transformation for the character string: 0 means render in the XY plane; 1 means render in the YZ plane; 2 means render in the YZ plane.

orient

UIoptionMenu. Used in conjunction with the plane and angle subobjects, specifies the transformation for the character string: 0 means left to right; 1 means up; 2 means right to left; 3 means down; 4 means arbitrary.

angle

UIoptionMenu. Used with arbitrary orientation, this parameter specifies the angle at which the text will be rendered. Valid values are between -180.00 and 180.00.

path

UIoptionMenu.This parameter specifies the direction of the text path: 0 means left to right; 1 means up; 2 means right to left; 3 means down.

space_mode

UIoptionMenu. This parameter specifies fixed or proportional spacing. Valid values are 0 for fixed spacing and 1 for proportional spacing. Default character spacing is set to 0.0.

spacing

UIslider. This parameter modifies the default character spacing. Specifying a value greater than 0.0 increases the spacing between characters; specifying a value less than 0.0 decreases the spacing between characters.

height

UIslider. This parameter specifies the height of the character; the default character height is 1.0. It is used as a scale factor for both the height and width of the character.

expansion

UIslider. This parameter specifies the width of the character. The default value is 1.0. Values less than 1.0 will make the characters narrower; values greater than 1.0 make the characters wider.

Output Port

DefaultObject

DefaultObject. A Graphics Display Kit object that can be connected directly to one of the AVS/Express viewers to be rendered.

Example

Libraries.Examples.Graphics_Display.AnnoCamera

File

v/geoms.v

See also related modules

Text