TextTitle
Synopsis
TextTitle adds a title to the output
Input Port
parent
|
user interface parent object
|
Parameters
str
|
string
|
align_horiz
|
int
|
align_vert
|
int
|
drop_shadow
|
int
|
background
|
int
|
bounds
|
int
|
underline
|
int
|
lead_line
|
int
|
radial
|
int
|
do_offset
|
int
|
offset
|
float[3]
|
xform_mode
|
int
|
nspace
|
int
|
position
|
float[3]
|
stroke
|
int
|
StrokeTextAttribs
|
|
min_vec
|
float[3]
|
max_vec
|
float[3]
|
Output Port
Description
Using TextTitle will add a title to the output
Input
parent (UIconnections)
A port to connect to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. (This default connection is not drawn.)
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 (int)
UItoggle. This controls if a drop shadow is rendered: unset means no; set means yes. Not available for Stroke Text.
background (int)
UItoggle. This controls if a background is rendered in the view's background color: unset means no; set means yes.
bounds (int)
UItoggle. This controls if a bounding box is rendered around the text string: unset means no; set means yes.
underline (int)
UItoggle. This controls if the text string is underlined: 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.
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)
Example
Not available
File
v/
See also related modules
