Inheritance diagram for HPS.Text:

Public Types

enum  Alignment : uint {
  Alignment.TopLeft = 0x00000000, Alignment.CenterLeft = 0x00000001, Alignment.BottomLeft = 0x00000002, Alignment.TopCenter = 0x00000003,
  Alignment.Center = 0x00000004, Alignment.BottomCenter = 0x00000005, Alignment.TopRight = 0x00000006, Alignment.CenterRight = 0x00000007,
  Alignment.BottomRight = 0x00000008
}



 
enum  GreekingMode : uint { GreekingMode.Nothing = 0x00000000, GreekingMode.Lines = 0x00000001, GreekingMode.Box = 0x00000002 }
 
enum  GreekingUnits : uint {
  GreekingUnits.ObjectSpace = 0x00000000, GreekingUnits.SubscreenRelative = 0x00000001, GreekingUnits.WindowRelative = 0x00000002, GreekingUnits.WorldSpace = 0x00000003,
  GreekingUnits.Points = 0x00000004, GreekingUnits.Pixels = 0x00000005
}

 
enum  Justification : uint { Justification.Left = 0x00000000, Justification.Right = 0x00000001, Justification.Center = 0x00000002 }
 
enum  LeaderLineSpace : uint { LeaderLineSpace.Object = 0x00000000, LeaderLineSpace.World = 0x00000001 }
 
enum  MarginUnits : uint {
  MarginUnits.ObjectSpace = 0x00000000, MarginUnits.SubscreenRelative = 0x00000001, MarginUnits.WindowRelative = 0x00000002, MarginUnits.WorldSpace = 0x00000003,
  MarginUnits.Points = 0x00000004, MarginUnits.Pixels = 0x00000005, MarginUnits.Percent = 0x00000006
}
 
enum  Preference : uint { Preference.Default = 0x00000000, Preference.Vector = 0x00000001, Preference.Raster = 0x00000002, Preference.Exterior = 0x00000003 }
 
enum  ReferenceFrame : uint { ReferenceFrame.WorldAligned = 0x00000000, ReferenceFrame.PathAligned = 0x00000001 }
 
enum  RegionAlignment : uint { RegionAlignment.Top = 0x00000000, RegionAlignment.Center = 0x00000001, RegionAlignment.Bottom = 0x00000002 }
 
enum  RegionFitting : uint {
  RegionFitting.Left = 0x00000000, RegionFitting.Center = 0x00000001, RegionFitting.Right = 0x00000002, RegionFitting.Spacing = 0x00000003,
  RegionFitting.Width = 0x00000004, RegionFitting.Auto = 0x00000005
}
 
enum  Renderer : uint { Renderer.Default = 0x00000000, Renderer.Driver = 0x00000001, Renderer.Truetype = 0x00000002 }
 
enum  Rotation : uint { Rotation.None = 0x00000000, Rotation.Rotate = 0x00000001, Rotation.FollowPath = 0x00000002 }
 
enum  SizeToleranceUnits : uint {
  SizeToleranceUnits.ObjectSpace = 0x00000000, SizeToleranceUnits.SubscreenRelative = 0x00000001, SizeToleranceUnits.WindowRelative = 0x00000002, SizeToleranceUnits.WorldSpace = 0x00000003,
  SizeToleranceUnits.Points = 0x00000004, SizeToleranceUnits.Pixels = 0x00000005, SizeToleranceUnits.Percent = 0x00000006
}
 
enum  SizeUnits : uint {
  SizeUnits.ObjectSpace = 0x00000000, SizeUnits.SubscreenRelative = 0x00000001, SizeUnits.WindowRelative = 0x00000002, SizeUnits.WorldSpace = 0x00000003,
  SizeUnits.Points = 0x00000004, SizeUnits.Pixels = 0x00000005
}
 
enum  Transform : uint {
  Transformable = 0x00000000, NonTransformable = 0x00000001, CharacterPositionOnly = 0x00000002, CharacterPositionAdjusted = 0x00000003,
  NonScalingTransformable = 0x00000004
}
 

Public Member Functions

virtual void Dispose ()
 
 Text (HPS.Text in_that)
 

Protected Member Functions

virtual void deleteCptr ()
 

Protected Attributes

bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Member Enumeration Documentation

◆ Alignment

enum HPS.Text.Alignment : uint
strong

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

Enumerator
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.

◆ GreekingMode

enum HPS.Text.GreekingMode : uint
strong

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

Enumerator
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.

◆ GreekingUnits

enum HPS.Text.GreekingUnits : uint
strong

Enumerates the units for greeking limits.

Enumerator
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.

◆ Justification

enum HPS.Text.Justification : uint
strong

Enumerates the justifications used for multiline text strings.

Enumerator
Left 

Multiline strings will be left justified.

Right 

Multiline strings will be right justified.

Center 

Multiline strings will be center justified.

◆ LeaderLineSpace

enum HPS.Text.LeaderLineSpace : uint
strong

Enumerates the spaces in which leader lines can be defined.

Enumerator
Object 

The leader line position is supplied in Object Space.

World 

The leader line position is supplied in World Space.

◆ MarginUnits

enum HPS.Text.MarginUnits : uint
strong

Enumerates the units for background margins.

Enumerator
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.

◆ Preference

enum HPS.Text.Preference : uint
strong

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

Enumerator
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).

◆ ReferenceFrame

enum HPS.Text.ReferenceFrame : uint
strong

Enumeration of the reference frames for text alignment and justification.

Enumerator
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.

◆ RegionAlignment

enum HPS.Text.RegionAlignment : uint
strong

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

Enumerator
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.

◆ RegionFitting

enum HPS.Text.RegionFitting : uint
strong

Enumerates how text is arranged within a region.

Enumerator
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. This will behave as Width when the text needs to be squeezed, or as Spacing when the text needs to be stretched.

◆ Renderer

enum HPS.Text.Renderer : uint
strong

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

Enumerator
Default 

All font-handling subsystems will be used.

Driver 

Only driver fonts will be used. If a non-driver font is requested, the stroked font will be used instead.

Truetype 

Only TrueType fonts will be used. If a non-TrueType font is requested, the stroked font will be used instead.

◆ Rotation

enum HPS.Text.Rotation : uint
strong
Enumerator
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.

◆ SizeToleranceUnits

enum HPS.Text.SizeToleranceUnits : uint
strong

Enumerates the units for size tolerances.

Enumerator
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.

◆ SizeUnits

enum HPS.Text.SizeUnits : uint
strong

Enumerates the units for font sizes.

Enumerator
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.

◆ Transform

enum HPS.Text.Transform : uint
strong

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


The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.Text.cs