
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 (if the object is derived, this does not give the true type of the derived object). 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 | SetBody (HPS.LinePatternElement in_element) |
Sets the line pattern element body 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... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.LinePatternParallelKit a, HPS.LinePatternParallelKit b) |
static bool | operator== (HPS.LinePatternParallelKit a, HPS.LinePatternParallelKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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]
|
inline |
The default constructor creates an empty LinePatternParallelKit object.
◆ LinePatternParallelKit() [2/2]
|
inline |
The copy constructor creates a new LinePatternParallelKit object that contains the same settings as the source LinePatternParallelKit.
- Parameters
-
in_kit The source LinePatternParallelKit to copy.
Member Function Documentation
◆ 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()
|
inline |
Check if the source LinePatternParallelKit is equivalent to this LinePatternParallelKit.
- Parameters
-
in_kit The source LinePatternParallelKit to compare to this LinePatternParallelKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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()
|
inline |
Copies the source LinePatternParallelKit into this LinePatternParallelKit.
- Parameters
-
in_kit The source LinePatternParallelKit to copy.
◆ SetAbsoluteLength()
|
inline |
Sets a flag indicating whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
- Parameters
-
in_state Whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetAbsoluteWeight()
|
inline |
Sets a flag indicating whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
- Parameters
-
in_state Whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetBody() [1/2]
|
inline |
Sets the line pattern element array for this LinePatternParallelKit.
- Parameters
-
in_elements The line pattern element array for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetBody() [2/2]
|
inline |
Sets the line pattern element body for this LinePatternParallelKit.
- Parameters
-
in_element The line pattern element body for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetContinuous()
|
inline |
Sets whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Parameters
-
in_state Whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetEndCap()
|
inline |
Sets the glyph to draw at the end point for this LinePatternParallelKit.
- Parameters
-
in_end The glyph to draw at the end point for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetJoin()
|
inline |
Sets the glyph to draw at all joins for this LinePatternParallelKit.
- Parameters
-
in_join The glyph to draw at all joins for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetJustification()
|
inline |
Sets how the pattern will fit between the end points for this LinePatternParallelKit.
- Parameters
-
in_type How the pattern will fit between the end points for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetOffset() [1/2]
|
inline |
Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
- Parameters
-
in_offset The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit. in_units The units for the offset for this LinePatternParallelKit. in_fixed Whether 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]
|
inline |
Sets the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
- Parameters
-
in_offset The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit. in_units The units for the offset for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetStartCap()
|
inline |
Sets the glyph to draw at the start point for this LinePatternParallelKit.
- Parameters
-
in_start The glyph to draw at the start point for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ SetWeight() [1/2]
|
inline |
Sets the line weight for this LinePatternParallelKit.
- Parameters
-
in_weight The line weight for this LinePatternParallelKit. in_units The units for the weight for this LinePatternParallelKit. in_fixed Whether 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]
|
inline |
Sets the line weight for this LinePatternParallelKit.
- Parameters
-
in_weight The line weight for this LinePatternParallelKit. in_units The units for the weight for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ Show()
|
inline |
Copies this LinePatternParallelKit into the given LinePatternParallelKit.
- Parameters
-
out_kit The LinePatternParallelKit to populate with the contents of this LinePatternParallelKit.
◆ ShowAbsoluteLength()
|
inline |
Shows whether to prevent scaling line pattern elements whose size is specified in pixels for this LinePatternParallelKit.
- Parameters
-
out_state Whether 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()
|
inline |
Shows whether to prevent scaling line pattern elements whose weight is specified in pixels for this LinePatternParallelKit.
- Parameters
-
out_state Whether 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()
|
inline |
Shows the line pattern element body for this LinePatternParallelKit.
- Parameters
-
out_elements The line pattern element body for this LinePatternParallelKit.
- Returns
- true if a body was set, false otherwise.
◆ ShowContinuous()
|
inline |
Shows whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Parameters
-
out_state Whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Returns
- true if a continuous flag was set, false otherwise.
◆ ShowEndCap()
|
inline |
Shows the glyph to draw at the end point for this LinePatternParallelKit.
- Parameters
-
out_end The glyph to draw at the end point for this LinePatternParallelKit.
- Returns
- true if an end cap was set, false otherwise.
◆ ShowJoin()
|
inline |
Shows the glyph to draw at all joins for this LinePatternParallelKit.
- Parameters
-
out_join The glyph to draw at all joins for this LinePatternParallelKit.
- Returns
- true if a join was set, false otherwise.
◆ ShowJustification()
|
inline |
Shows how the pattern will fit between the end points for this LinePatternParallelKit.
- Parameters
-
out_type How the pattern will fit between the end points for this LinePatternParallelKit.
- Returns
- true if a justficiation was set, false otherwise.
◆ ShowOffset()
|
inline |
Shows the offset above or below the line connecting two points defining a segment for this LinePatternParallelKit.
- Parameters
-
out_offset The offset above (positive) or below (negative) the line connecting two points defining a segment for this LinePatternParallelKit. out_units The units for the offset for this LinePatternParallelKit. out_fixed Whether 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()
|
inline |
Shows the glyph to draw at the start point for this LinePatternParallelKit.
- Parameters
-
out_start The glyph to draw at the start point for this LinePatternParallelKit.
- Returns
- true if a start cap was set, false otherwise.
◆ ShowWeight()
|
inline |
Shows the line weight for this LinePatternParallelKit.
- Parameters
-
out_weight The line weight for this LinePatternParallelKit. out_units The units for the weight for this LinePatternParallelKit. out_fixed Whether to override the effective line weight in the segment where this pattern is used.
- Returns
- true if a weight was set, false otherwise.
◆ 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()
|
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()
|
inline |
Removes the line pattern element body for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ UnsetContinuous()
|
inline |
Removes whether to reset the line pattern in each segment for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ UnsetEndCap()
|
inline |
Removes the glyph to draw at the end point for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ UnsetEverything()
|
inline |
Removes all settings from this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ UnsetJoin()
|
inline |
Removes the glyph to draw at all joins for this LinePatternParallelKit.
- Returns
- A reference to this LinePatternParallelKit.
◆ UnsetJustification()
|
inline |
Removes how the pattern will fit between the end points for this LinePatternParallelKit.
- Returns
- A reference to this 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()
|
inline |
Removes the glyph to draw at the start point for this LinePatternParallelKit.
- Returns
- A reference to this 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