HPS.GlyphLinePatternElement Class Reference
Inheritance diagram for HPS.GlyphLinePatternElement:
HPS.LinePatternElement HPS.Object

Public Member Functions

override void Dispose ()
 
 GlyphLinePatternElement ()
 
 GlyphLinePatternElement (HPS.LinePatternElement in_that)
 
 GlyphLinePatternElement (HPS.GlyphLinePatternElement in_that)
 
override HPS.Type ObjectType ()
 
void SetFixed (bool in_state)
 
void SetInsetBehavior (HPS.LinePattern.InsetBehavior in_behavior)
 
void SetMirror (bool in_state)
 
void SetRotation (float in_degrees)
 
void SetSource (string in_source)
 
void SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units)
 
bool ShowFixed (out bool out_state)
 
bool ShowInsetBehavior (out HPS.LinePattern.InsetBehavior out_behavior)
 
bool ShowMirror (out bool out_state)
 
bool ShowRotation (out float out_degrees)
 
bool ShowSource (out string out_source)
 
bool ShowWeight (out float out_weight, out HPS.LinePattern.SizeUnits out_units)
 
- Public Member Functions inherited from HPS.LinePatternElement
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.LinePatternElement in_that)
 
override int GetHashCode ()
 
 LinePatternElement ()
 
 LinePatternElement (HPS.LinePatternElement in_that)
 
override HPS.Type ObjectType ()
 
void Set (HPS.LinePatternElement in_that)
 
void SetSize (float in_size, HPS.LinePattern.SizeUnits in_units)
 
bool ShowSize (out float out_size, out HPS.LinePattern.SizeUnits out_units)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.LinePatternElement
override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.LinePatternElement
static bool operator!= (HPS.LinePatternElement a, HPS.LinePatternElement b)
 
static bool operator== (HPS.LinePatternElement a, HPS.LinePatternElement b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The GlyphLinePatternElement class is a user space object. It is used for specifying glyphs elements within a line pattern.

Constructor & Destructor Documentation

◆ GlyphLinePatternElement() [1/3]

HPS.GlyphLinePatternElement.GlyphLinePatternElement ( )
inline

The default constructor creates an empty GlyphLinePatternElement object.

◆ GlyphLinePatternElement() [2/3]

HPS.GlyphLinePatternElement.GlyphLinePatternElement ( HPS.LinePatternElement  in_that)
inline

This constructor creates a GlyphLinePatternElement object that contains the same settings as the source LinePatternElement. The copy will only be successful if the source line pattern element is really an upcast of a glyph line pattern element. Otherwise the copy will fail and the resulting GlyphLinePatternElement will be invalid.

Parameters
in_thatThe source LinePatternElement to copy.

◆ GlyphLinePatternElement() [3/3]

HPS.GlyphLinePatternElement.GlyphLinePatternElement ( HPS.GlyphLinePatternElement  in_that)
inline

The copy constructor creates a new GlyphLinePatternElement object that contains the same settings as the source GlyphLinePatternElement.

Parameters
in_thatThe source GlyphLinePatternElement to copy.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.GlyphLinePatternElement.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

◆ SetFixed()

void HPS.GlyphLinePatternElement.SetFixed ( bool  in_state)
inline

Sets whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

Parameters
in_stateWhether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

◆ SetInsetBehavior()

void HPS.GlyphLinePatternElement.SetInsetBehavior ( HPS.LinePattern.InsetBehavior  in_behavior)
inline

Sets the inset behavior for this GlyphLinePatternElement.

Parameters
in_behaviorThe inset behavior for this GlyphLinePatternElement.

◆ SetMirror()

void HPS.GlyphLinePatternElement.SetMirror ( bool  in_state)
inline

Sets whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

Parameters
in_stateWhether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

◆ SetRotation()

void HPS.GlyphLinePatternElement.SetRotation ( float  in_degrees)
inline

Sets the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

Parameters
in_degreesThe angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

◆ SetSource()

void HPS.GlyphLinePatternElement.SetSource ( string  in_source)
inline

Sets the name of the source for this GlyphLinePatternElement.

Parameters
in_sourceUTF8-encoded name of the source for this GlyphLinePatternElement.

◆ SetWeight()

void HPS.GlyphLinePatternElement.SetWeight ( float  in_weight,
HPS.LinePattern.SizeUnits  in_units 
)
inline

Sets the weight for this GlyphLinePatternElement.

Parameters
in_weightThe weight for this GlyphLinePatternElement.
in_unitsThe units of the weight for this GlyphLinePatternElement.

◆ ShowFixed()

bool HPS.GlyphLinePatternElement.ShowFixed ( out bool  out_state)
inline

Shows whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

Parameters
out_stateWhether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.
Returns
true if a fixed flag was set, false otherwise.

◆ ShowInsetBehavior()

bool HPS.GlyphLinePatternElement.ShowInsetBehavior ( out HPS.LinePattern.InsetBehavior  out_behavior)
inline

Shows the inset behavior for this GlyphLinePatternElement.

Parameters
out_behaviorThe inset behavior for this GlyphLinePatternElement.
Returns
true if an inset behavior was set, false otherwise.

◆ ShowMirror()

bool HPS.GlyphLinePatternElement.ShowMirror ( out bool  out_state)
inline

Shows whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

Parameters
out_stateWhether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.
Returns
true if a mirror flag was set, false otherwise.

◆ ShowRotation()

bool HPS.GlyphLinePatternElement.ShowRotation ( out float  out_degrees)
inline

Shows the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

Parameters
out_degreesThe angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.
Returns
true if an angle was set, false otherwise.

◆ ShowSource()

bool HPS.GlyphLinePatternElement.ShowSource ( out string  out_source)
inline

Shows the name of the source for this GlyphLinePatternElement.

Parameters
out_sourceUTF8-encoded name of the source for this GlyphLinePatternElement.
Returns
true if a source was set, false otherwise.

◆ ShowWeight()

bool HPS.GlyphLinePatternElement.ShowWeight ( out float  out_weight,
out HPS.LinePattern.SizeUnits  out_units 
)
inline

Shows the weight for this GlyphLinePatternElement.

Parameters
out_weightThe weight for this GlyphLinePatternElement.
out_unitsThe units for the weight for this GlyphLinePatternElement.
Returns
true if a weight was set, false otherwise.

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