Inheritance diagram for HPS.LinePatternParallelKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.LinePatternParallelKit in_kit)
 
override int GetHashCode ()
 
 LinePatternParallelKit ()
 
 LinePatternParallelKit (HPS.LinePatternParallelKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.LinePatternParallelKit in_kit)
 
HPS.LinePatternParallelKit SetAbsoluteLength (bool in_state)
 
HPS.LinePatternParallelKit SetAbsoluteWeight (bool in_state)
 
HPS.LinePatternParallelKit SetBody (HPS.LinePatternElement[] in_elements)
 
HPS.LinePatternParallelKit SetBody (HPS.LinePatternElement in_element)
 
HPS.LinePatternParallelKit SetContinuous (bool in_state)
 
HPS.LinePatternParallelKit SetEndCap (HPS.GlyphLinePatternElement in_end)
 
HPS.LinePatternParallelKit SetJoin (HPS.GlyphLinePatternElement in_join)
 
HPS.LinePatternParallelKit SetJustification (HPS.LinePattern.Justification in_type)
 
HPS.LinePatternParallelKit SetOffset (float in_offset, HPS.LinePattern.SizeUnits in_units, bool in_fixed)
 
HPS.LinePatternParallelKit SetOffset (float in_offset, HPS.LinePattern.SizeUnits in_units)
 
HPS.LinePatternParallelKit SetStartCap (HPS.GlyphLinePatternElement in_start)
 
HPS.LinePatternParallelKit SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units, bool in_fixed)
 
HPS.LinePatternParallelKit SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units)
 
void Show (out HPS.LinePatternParallelKit out_kit)
 
bool ShowAbsoluteLength (out bool out_state)
 
bool ShowAbsoluteWeight (out bool out_state)
 
bool ShowBody (out HPS.LinePatternElement[] out_elements)
 
bool ShowContinuous (out bool out_state)
 
bool ShowEndCap (out HPS.GlyphLinePatternElement out_end)
 
bool ShowJoin (out HPS.GlyphLinePatternElement out_join)
 
bool ShowJustification (out HPS.LinePattern.Justification out_type)
 
bool ShowOffset (out float out_offset, out HPS.LinePattern.SizeUnits out_units, out bool out_fixed)
 
bool ShowStartCap (out HPS.GlyphLinePatternElement out_start)
 
bool ShowWeight (out float out_weight, out HPS.LinePattern.SizeUnits out_units, out bool out_fixed)
 
HPS.LinePatternParallelKit UnsetAbsoluteLength ()
 
HPS.LinePatternParallelKit UnsetAbsoluteWeight ()
 
HPS.LinePatternParallelKit UnsetBody ()
 
HPS.LinePatternParallelKit UnsetContinuous ()
 
HPS.LinePatternParallelKit UnsetEndCap ()
 
HPS.LinePatternParallelKit UnsetEverything ()
 
HPS.LinePatternParallelKit UnsetJoin ()
 
HPS.LinePatternParallelKit UnsetJustification ()
 
HPS.LinePatternParallelKit UnsetOffset ()
 
HPS.LinePatternParallelKit UnsetStartCap ()
 
HPS.LinePatternParallelKit UnsetWeight ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.LinePatternParallelKit a, HPS.LinePatternParallelKit b)
 
static bool operator== (HPS.LinePatternParallelKit a, HPS.LinePatternParallelKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The LinePatternParallelKit class is a user space object. It is used to define a single parallel within a line pattern.

Constructor & Destructor Documentation

◆ LinePatternParallelKit() [1/2]

HPS.LinePatternParallelKit.LinePatternParallelKit ( )
inline

The default constructor creates an empty LinePatternParallelKit object.

◆ LinePatternParallelKit() [2/2]

HPS.LinePatternParallelKit.LinePatternParallelKit ( HPS.LinePatternParallelKit  in_kit)
inline

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

Parameters
in_kitThe source LinePatternParallelKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.LinePatternParallelKit.Empty ( )
inlinevirtual

Indicates whether this LinePatternParallelKit has any values set on it.

Returns
true if no values are set on this LinePatternParallelKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.LinePatternParallelKit.Equals ( HPS.LinePatternParallelKit  in_kit)
inline

Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.

Parameters
in_kitThe source LinePatternParallelKit to compare to this LinePatternParallelKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.LinePatternParallelKit.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.Kit.

◆ Set()

void HPS.LinePatternParallelKit.Set ( HPS.LinePatternParallelKit  in_kit)
inline

Copies the source LinePatternParallelKit into this LinePatternParallelKit.

Parameters
in_kitThe source LinePatternParallelKit to copy.

◆ SetAbsoluteLength()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetAbsoluteLength ( bool  in_state)
inline

Sets a flag indicating whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.

Parameters
in_stateWhether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetAbsoluteWeight()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetAbsoluteWeight ( bool  in_state)
inline

Sets a flag indicating whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.

Parameters
in_stateWhether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetBody() [1/2]

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetBody ( HPS.LinePatternElement []  in_elements)
inline

Sets the line pattern element array for this LinePatternParallelKit.

Parameters
in_elementsThe line pattern element array for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetBody() [2/2]

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetBody ( HPS.LinePatternElement  in_element)
inline

Sets the line pattern element body for this LinePatternParallelKit.

Parameters
in_elementThe line pattern element body for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetContinuous()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetContinuous ( bool  in_state)
inline

Sets whether to reset the line pattern in each segment for this LinePatternParallelKit.

Parameters
in_stateWhether to reset the line pattern in each segment for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetEndCap()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetEndCap ( HPS.GlyphLinePatternElement  in_end)
inline

Sets the glyph to draw at the end point for this LinePatternParallelKit.

Parameters
in_endThe glyph to draw at the end point for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetJoin()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetJoin ( HPS.GlyphLinePatternElement  in_join)
inline

Sets the glyph to draw at all joins for this LinePatternParallelKit.

Parameters
in_joinThe glyph to draw at all joins for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetJustification()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetJustification ( HPS.LinePattern.Justification  in_type)
inline

Sets how the pattern will fit between the end points for this LinePatternParallelKit.

Parameters
in_typeHow the pattern will fit between the end points for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetOffset() [1/2]

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetOffset ( float  in_offset,
HPS.LinePattern.SizeUnits  in_units,
bool  in_fixed 
)
inline

Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.

Parameters
in_offsetThe offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit.
in_unitsThe units for the offset for this LinePatternParallelKit.
in_fixedWhether to prevent scaling the offset based on the effective line weight in the segment where this pattern is used. Defaults to false.
Returns
A reference to this LinePatternParallelKit.

◆ SetOffset() [2/2]

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetOffset ( float  in_offset,
HPS.LinePattern.SizeUnits  in_units 
)
inline

Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.

Parameters
in_offsetThe offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit.
in_unitsThe units for the offset for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetStartCap()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetStartCap ( HPS.GlyphLinePatternElement  in_start)
inline

Sets the glyph to draw at the start point for this LinePatternParallelKit.

Parameters
in_startThe glyph to draw at the start point for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ SetWeight() [1/2]

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetWeight ( float  in_weight,
HPS.LinePattern.SizeUnits  in_units,
bool  in_fixed 
)
inline

Sets the line weight for this LinePatternParallelKit.

Parameters
in_weightThe line weight for this LinePatternParallelKit.
in_unitsThe units for the weight for this LinePatternParallelKit.
in_fixedWhether to override the effective line weight in the segment where this pattern is used. Defaults to false.
Returns
A reference to this LinePatternParallelKit.

◆ SetWeight() [2/2]

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

Sets the line weight for this LinePatternParallelKit.

Parameters
in_weightThe line weight for this LinePatternParallelKit.
in_unitsThe units for the weight for this LinePatternParallelKit.
Returns
A reference to this LinePatternParallelKit.

◆ Show()

void HPS.LinePatternParallelKit.Show ( out HPS.LinePatternParallelKit  out_kit)
inline

Copies this LinePatternParallelKit into the given LinePatternParallelKit.

Parameters
out_kitThe LinePatternParallelKit to populate with the contents of this LinePatternParallelKit.

◆ ShowAbsoluteLength()

bool HPS.LinePatternParallelKit.ShowAbsoluteLength ( out bool  out_state)
inline

Shows whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.

Parameters
out_stateWhether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
Returns
true if an absolute length was set, false otherwise.

◆ ShowAbsoluteWeight()

bool HPS.LinePatternParallelKit.ShowAbsoluteWeight ( out bool  out_state)
inline

Shows whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.

Parameters
out_stateWhether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
Returns
true if an absolute weight was set, false otherwise.

◆ ShowBody()

bool HPS.LinePatternParallelKit.ShowBody ( out HPS.LinePatternElement []  out_elements)
inline

Shows the line pattern element body for this LinePatternParallelKit.

Parameters
out_elementsThe line pattern element body for this LinePatternParallelKit.
Returns
true if a body was set, false otherwise.

◆ ShowContinuous()

bool HPS.LinePatternParallelKit.ShowContinuous ( out bool  out_state)
inline

Shows whether to reset the line pattern in each segment for this LinePatternParallelKit.

Parameters
out_stateWhether to reset the line pattern in each segment for this LinePatternParallelKit.
Returns
true if a continuous flag was set, false otherwise.

◆ ShowEndCap()

bool HPS.LinePatternParallelKit.ShowEndCap ( out HPS.GlyphLinePatternElement  out_end)
inline

Shows the glyph to draw at the end point for this LinePatternParallelKit.

Parameters
out_endThe glyph to draw at the end point for this LinePatternParallelKit.
Returns
true if an end cap was set, false otherwise.

◆ ShowJoin()

bool HPS.LinePatternParallelKit.ShowJoin ( out HPS.GlyphLinePatternElement  out_join)
inline

Shows the glyph to draw at all joins for this LinePatternParallelKit.

Parameters
out_joinThe glyph to draw at all joins for this LinePatternParallelKit.
Returns
true if a join was set, false otherwise.

◆ ShowJustification()

bool HPS.LinePatternParallelKit.ShowJustification ( out HPS.LinePattern.Justification  out_type)
inline

Shows how the pattern will fit between the end points for this LinePatternParallelKit.

Parameters
out_typeHow the pattern will fit between the end points for this LinePatternParallelKit.
Returns
true if a justficiation was set, false otherwise.

◆ ShowOffset()

bool HPS.LinePatternParallelKit.ShowOffset ( out float  out_offset,
out HPS.LinePattern.SizeUnits  out_units,
out bool  out_fixed 
)
inline

Shows the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.

Parameters
out_offsetThe offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit.
out_unitsThe units for the offset for this LinePatternParallelKit.
out_fixedWhether to prevent scaling the offset based on the effective line weight in the segment where this pattern is used.
Returns
true if an offset is set, false otherwise.

◆ ShowStartCap()

bool HPS.LinePatternParallelKit.ShowStartCap ( out HPS.GlyphLinePatternElement  out_start)
inline

Shows the glyph to draw at the start point for this LinePatternParallelKit.

Parameters
out_startThe glyph to draw at the start point for this LinePatternParallelKit.
Returns
true if a start cap was set, false otherwise.

◆ ShowWeight()

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

Shows the line weight for this LinePatternParallelKit.

Parameters
out_weightThe line weight for this LinePatternParallelKit.
out_unitsThe units for the weight for this LinePatternParallelKit.
out_fixedWhether to override the effective line weight in the segment where this pattern is used.
Returns
true if a weight was set, false otherwise.

◆ UnsetAbsoluteLength()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetAbsoluteLength ( )
inline

Removes whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetAbsoluteWeight()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetAbsoluteWeight ( )
inline

Removes whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetBody()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetBody ( )
inline

Removes the line pattern element body for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetContinuous()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetContinuous ( )
inline

Removes whether to reset the line pattern in each segment for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetEndCap()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetEndCap ( )
inline

Removes the glyph to draw at the end point for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetEverything()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetEverything ( )
inline

Removes all settings from this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetJoin()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetJoin ( )
inline

Removes the glyph to draw at all joins for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetJustification()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetJustification ( )
inline

Removes how the pattern will fit between the end points for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetOffset()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetOffset ( )
inline

Removes the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetStartCap()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetStartCap ( )
inline

Removes the glyph to draw at the start point for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

◆ UnsetWeight()

HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetWeight ( )
inline

Removes the line weight for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

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