< Home

< Table of Contents

REFERENCE MANUAL

HPS.LinePatternParallelKit Class Reference

The LinePatternParallelKit class is a user space object. More...

Inheritance diagram for HPS.LinePatternParallelKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this LinePatternParallelKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.LinePatternParallelKit in_kit)
 Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit. More...
 
override int GetHashCode ()
 
 LinePatternParallelKit ()
 The default constructor creates an empty LinePatternParallelKit object. More...
 
 LinePatternParallelKit (HPS.LinePatternParallelKit in_kit)
 The copy constructor creates a new LinePatternParallelKit object that contains the same settings as the source LinePatternParallelKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.LinePatternParallelKit in_kit)
 Copies the source LinePatternParallelKit into this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetAbsoluteLength (bool in_state)
 Sets a flag indicating whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetAbsoluteWeight (bool in_state)
 Sets a flag indicating whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetBody (HPS.LinePatternElement[] in_elements)
 Sets the line pattern element array for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetContinuous (bool in_state)
 Sets whether to reset the line pattern in each segment for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetEndCap (HPS.GlyphLinePatternElement in_end)
 Sets the glyph to draw at the end point for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetJoin (HPS.GlyphLinePatternElement in_join)
 Sets the glyph to draw at all joins for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetJustification (HPS.LinePattern.Justification in_type)
 Sets how the pattern will fit between the end points for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetOffset (float in_offset, HPS.LinePattern.SizeUnits in_units, bool in_fixed)
 Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetOffset (float in_offset, HPS.LinePattern.SizeUnits in_units)
 Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetStartCap (HPS.GlyphLinePatternElement in_start)
 Sets the glyph to draw at the start point for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units, bool in_fixed)
 Sets the line weight for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit SetWeight (float in_weight, HPS.LinePattern.SizeUnits in_units)
 Sets the line weight for this LinePatternParallelKit. More...
 
void Show (out HPS.LinePatternParallelKit out_kit)
 Copies this LinePatternParallelKit into the given LinePatternParallelKit. More...
 
bool ShowAbsoluteLength (out bool out_state)
 Shows whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. More...
 
bool ShowAbsoluteWeight (out bool out_state)
 Shows whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. More...
 
bool ShowBody (out HPS.LinePatternElement[] out_elements)
 Shows the line pattern element body for this LinePatternParallelKit. More...
 
bool ShowContinuous (out bool out_state)
 Shows whether to reset the line pattern in each segment for this LinePatternParallelKit. More...
 
bool ShowEndCap (out HPS.GlyphLinePatternElement out_end)
 Shows the glyph to draw at the end point for this LinePatternParallelKit. More...
 
bool ShowJoin (out HPS.GlyphLinePatternElement out_join)
 Shows the glyph to draw at all joins for this LinePatternParallelKit. More...
 
bool ShowJustification (out HPS.LinePattern.Justification out_type)
 Shows how the pattern will fit between the end points for this LinePatternParallelKit. More...
 
bool ShowOffset (out float out_offset, out HPS.LinePattern.SizeUnits out_units, out bool out_fixed)
 Shows the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit. More...
 
bool ShowStartCap (out HPS.GlyphLinePatternElement out_start)
 Shows the glyph to draw at the start point for this LinePatternParallelKit. More...
 
bool ShowWeight (out float out_weight, out HPS.LinePattern.SizeUnits out_units, out bool out_fixed)
 Shows the line weight for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetAbsoluteLength ()
 Removes whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetAbsoluteWeight ()
 Removes whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetBody ()
 Removes the line pattern element body for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetContinuous ()
 Removes whether to reset the line pattern in each segment for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetEndCap ()
 Removes the glyph to draw at the end point for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetEverything ()
 Removes all settings from this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetJoin ()
 Removes the glyph to draw at all joins for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetJustification ()
 Removes how the pattern will fit between the end points for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetOffset ()
 Removes the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetStartCap ()
 Removes the glyph to draw at the start point for this LinePatternParallelKit. More...
 
HPS.LinePatternParallelKit UnsetWeight ()
 Removes the line weight for this LinePatternParallelKit. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

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
 
HandleRef scptr
 

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

HPS.LinePatternParallelKit.LinePatternParallelKit ( )

The default constructor creates an empty LinePatternParallelKit object.

HPS.LinePatternParallelKit.LinePatternParallelKit ( HPS.LinePatternParallelKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref> to copy.

Member Function Documentation

override bool HPS.LinePatternParallelKit.Empty ( )
virtual

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.

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

Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref> to compare to this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
override HPS.Type HPS.LinePatternParallelKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

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

Copies the source LinePatternParallelKit into this LinePatternParallelKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref> to copy.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetAbsoluteLength ( bool  in_state)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetAbsoluteWeight ( bool  in_state)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetBody ( HPS.LinePatternElement[]  in_elements)

Sets the line pattern element array for this LinePatternParallelKit.

Parameters
in_elementsThe line pattern element array for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetContinuous ( bool  in_state)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetEndCap ( HPS.GlyphLinePatternElement  in_end)

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

Parameters
in_endThe glyph to draw at the end point for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetJoin ( HPS.GlyphLinePatternElement  in_join)

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

Parameters
in_joinThe glyph to draw at all joins for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetJustification ( HPS.LinePattern.Justification  in_type)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetOffset ( float  in_offset,
HPS.LinePattern.SizeUnits  in_units,
bool  in_fixed 
)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
in_unitsThe units for the offset for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
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.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetOffset ( float  in_offset,
HPS.LinePattern.SizeUnits  in_units 
)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
in_unitsThe units for the offset for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetStartCap ( HPS.GlyphLinePatternElement  in_start)

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

Parameters
in_startThe glyph to draw at the start point for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetWeight ( float  in_weight,
HPS.LinePattern.SizeUnits  in_units,
bool  in_fixed 
)

Sets the line weight for this LinePatternParallelKit.

Parameters
in_weightThe line weight for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
in_unitsThe units for the weight for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
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.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.SetWeight ( float  in_weight,
HPS.LinePattern.SizeUnits  in_units 
)

Sets the line weight for this LinePatternParallelKit.

Parameters
in_weightThe line weight for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
in_unitsThe units for the weight for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
A reference to this LinePatternParallelKit.
void HPS.LinePatternParallelKit.Show ( out HPS.LinePatternParallelKit  out_kit)

Copies this LinePatternParallelKit into the given LinePatternParallelKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
bool HPS.LinePatternParallelKit.ShowAbsoluteLength ( out bool  out_state)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
true if an absolute length was set, false otherwise.
bool HPS.LinePatternParallelKit.ShowAbsoluteWeight ( out bool  out_state)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
true if an absolute weight was set, false otherwise.
bool HPS.LinePatternParallelKit.ShowBody ( out HPS.LinePatternElement[]  out_elements)

Shows the line pattern element body for this LinePatternParallelKit.

Parameters
out_elementsThe line pattern element body for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
true if a body was set, false otherwise.
bool HPS.LinePatternParallelKit.ShowContinuous ( out bool  out_state)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
true if a continuous flag was set, false otherwise.
bool HPS.LinePatternParallelKit.ShowEndCap ( out HPS.GlyphLinePatternElement  out_end)

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

Parameters
out_endThe glyph to draw at the end point for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
true if an end cap was set, false otherwise.
bool HPS.LinePatternParallelKit.ShowJoin ( out HPS.GlyphLinePatternElement  out_join)

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

Parameters
out_joinThe glyph to draw at all joins for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
true if a join was set, false otherwise.
bool HPS.LinePatternParallelKit.ShowJustification ( out HPS.LinePattern.Justification  out_type)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
true if a justficiation was set, false otherwise.
bool HPS.LinePatternParallelKit.ShowOffset ( out float  out_offset,
out HPS.LinePattern.SizeUnits  out_units,
out bool  out_fixed 
)

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 <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
out_unitsThe units for the offset for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
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.
bool HPS.LinePatternParallelKit.ShowStartCap ( out HPS.GlyphLinePatternElement  out_start)

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

Parameters
out_startThe glyph to draw at the start point for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
Returns
true if a start cap was set, false otherwise.
bool HPS.LinePatternParallelKit.ShowWeight ( out float  out_weight,
out HPS.LinePattern.SizeUnits  out_units,
out bool  out_fixed 
)

Shows the line weight for this LinePatternParallelKit.

Parameters
out_weightThe line weight for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
out_unitsThe units for the weight for this <ref refid="class_h_p_s_1_1_line_pattern_parallel_kit" kindref="compound">LinePatternParallelKit</ref>.
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.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetAbsoluteLength ( )

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

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetAbsoluteWeight ( )

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

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetBody ( )

Removes the line pattern element body for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetContinuous ( )

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

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetEndCap ( )

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

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetEverything ( )

Removes all settings from this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetJoin ( )

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

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetJustification ( )

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

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetOffset ( )

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

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetStartCap ( )

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

Returns
A reference to this LinePatternParallelKit.
HPS.LinePatternParallelKit HPS.LinePatternParallelKit.UnsetWeight ( )

Removes the line weight for this LinePatternParallelKit.

Returns
A reference to this LinePatternParallelKit.

The documentation for this class was generated from the following file: