Text

class HPS.Text : public IDisposable

The Text class is a concept class for text-related enum classes.

Public Types

enum Alignment

Enumeration of the alignments used for text string. These define what the insertion point for a text string is measured with respect to.

Values:

TopLeft

Insertion point is the top left corner of the text string.

CenterLeft

Insertion point is the center of the left side of the text string.

BottomLeft

Insertion point is the bottom left corner of the text string.

TopCenter

Insertion point is the center of the top side of the text string.

Center

Insertion point is the vertical and horizontal center of the text string.

BottomCenter

Insertion point is the center of the bottom side of the text string.

TopRight

Insertion point is the top right corner of the text string.

CenterRight

Insertion point is the center of the right side of the text string.

BottomRight

Insertion point is the bottom right corner of the text string.

enum GreekingMode

Enumerates the greeking modes. These define what to draw in place of characters once they fall below the greeking limit.

Values:

Nothing

Nothing will be drawn for characters below the greeking limit.

Lines

A grid of lines will be drawn in place of characters below the greeking limit.

Box

A filled box will be drawn in place of characters below the greeking limit.

enum GreekingUnits

Enumerates the units for greeking limits.

Values:

ObjectSpace

Object space units ignoring any scaling components in modelling matrices.

SubscreenRelative

Fraction of the height of the outermost window.

WindowRelative

Fraction of the height of the local window.

WorldSpace

Object space units including any scaling components in modelling matrices and cameras.

Points

Points units typically used for text size. 1 point corresponds to 1/72 inch.

Pixels

Number of pixels.

enum Justification

Enumerates the justifications used for multiline text strings.

Values:

Left

Multiline strings will be left justified.

Right

Multiline strings will be right justified.

Center

Multiline strings will be center justified.

enum LeaderLineSpace

Enumerates the spaces in which leader lines can be defined.

Values:

Object

The leader line position is supplied in Object Space.

World

The leader line position is supplied in World Space.

enum MarginUnits

Enumerates the units for background margins.

Values:

ObjectSpace

Object space units ignoring any scaling components in modelling matrices.

SubscreenRelative

Fraction of the height of the outermost window.

WindowRelative

Fraction of the height of the local window.

WorldSpace

Object space units including any scaling components in modelling matrices and cameras.

Points

Points units typically used for text size. 1 point corresponds to 1/72 inch.

Pixels

Number of pixels.

Percent

Percentage of the requested font height.

enum Preference

Enumerates the font type preferences for text strings. These define the types of fonts Visualize will use.

Values:

Default

Use the default font type for the current driver.

Vector

Use vector fonts.

Raster

Use raster or bitmap fonts.

Exterior

Use the font outline (characters will be unfilled).

enum ReferenceFrame

Enumeration of the reference frames for text alignment and justification.

Values:

WorldAligned

Alignment and justification will be defined relative to a screen-facing box around the text.

PathAligned

Alignment and justification will be defined relative to a text-path-aligned box around the text.

enum RegionAlignment

Enumerates the alignments for text regions. These define how text strings will be positioned relative to the line defining the text region.

Values:

Top

Text will be drawn below the region line.

Center

Text will be drawn such that the region line passes through its center.

Bottom

Text will be drawn above the region line.

enum RegionFitting

Enumerates how text is arranged within a region.

Values:

Left

Text will be left-justified on the region line.

Center

Text will be centered-justified on the region line.

Right

Text will be right-justified on the region line.

Spacing

Text will be stretched or squeezed to fill the region line and character width will not change (characters may overlap).

Width

Text will be stretched or squeezed to fill the region line and character width will change (narrowing or widening as necessary).

Auto

Text will be stretched or squeezed to fill the region line.

enum Renderer

Enumerates the renderers for text strings. These define the font-handling subsystems Visualize uses to find and render fonts.

Values:

Default

All font-handling subsystems will be used.

Driver

Only driver fonts will be used.

Truetype

Only TrueType fonts will be used.

enum Rotation

Values:

None

Characters are not rotated.

Rotate

Characters are rotated clockwise by a specified angle.

FollowPath

Characters are rotated such that they will be perpendicular to the text path.

enum SizeToleranceUnits

Enumerates the units for size tolerances.

Values:

ObjectSpace

Object space units ignoring any scaling components in modelling matrices.

SubscreenRelative

Fraction of the height of the outermost window.

WindowRelative

Fraction of the height of the local window.

WorldSpace

Object space units including any scaling components in modelling matrices and cameras.

Points

Points units typically used for text size. 1 point corresponds to 1/72 inch.

Pixels

Number of pixels.

Percent

Percentage of the requested font size defining the lower limit on the smallest font size that can be substituted in the requested’s place.

enum SizeUnits

Enumerates the units for font sizes.

Values:

ObjectSpace

Object space units ignoring any scaling components in modelling matrices.

SubscreenRelative

Fraction of the height of the outermost window.

WindowRelative

Fraction of the height of the local window.

WorldSpace

Object space units including any scaling components in modelling matrices and cameras.

Points

Points units typically used for text size. 1 point corresponds to 1/72 inch.

Pixels

Number of pixels.

enum Transform

Enumerates the transform behaviors for text strings. These define how the entire string will be positioned within 3D space.

Values:

Transformable
NonTransformable
CharacterPositionOnly
CharacterPositionAdjusted
NonScalingTransformable

Public Functions

void Dispose ()
Text (HPS.Text in_that)