The LinePatternOptionsKit class is a user space object. It is used for specifying (or overriding) some line pattern options when setting a line pattern on a segment. More...

Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this LinePatternOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.LinePatternOptionsKit in_kit) |
Check if the source LinePatternOptionsKit is equivalent to this LinePatternOptionsKit. More... | |
override int | GetHashCode () |
LinePatternOptionsKit () | |
The default constructor creates an empty LinePatternOptionsKit object. More... | |
LinePatternOptionsKit (HPS.LinePatternOptionsKit in_kit) | |
The copy constructor creates a new LinePatternOptionsKit object that contains the same settings as the source LinePatternOptionsKit. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.LinePatternOptionsKit in_kit) |
Copies the source LinePatternOptionsKit into this LinePatternOptionsKit. More... | |
HPS.LinePatternOptionsKit | SetEndCap (string in_glyph) |
Sets the glyph to use as the end cap for the associated line pattern. More... | |
HPS.LinePatternOptionsKit | SetEndCap (HPS.LinePattern.Cap in_type) |
Sets the cap to use as the end cap for the associated line pattern. More... | |
HPS.LinePatternOptionsKit | SetInnerCap (HPS.LinePattern.Cap in_type) |
Sets the cap to use as the inner cap for the associated line pattern. More... | |
HPS.LinePatternOptionsKit | SetJoin (string in_glyph) |
Sets the glyph to use as the join for the associated line pattern. More... | |
HPS.LinePatternOptionsKit | SetJoin (HPS.LinePattern.Join in_type) |
Sets the join to use for the associated line pattern. More... | |
HPS.LinePatternOptionsKit | SetStartCap (string in_glyph) |
Sets the glyph to use as the start cap for the associated line pattern. More... | |
HPS.LinePatternOptionsKit | SetStartCap (HPS.LinePattern.Cap in_type) |
Sets the cap to use as the start cap for the associated line pattern. More... | |
void | Show (out HPS.LinePatternOptionsKit out_kit) |
Copies this LinePatternOptionsKit into the given LinePatternOptionsKit. More... | |
bool | ShowEndCap (out HPS.LinePattern.Modifier out_modifier, out string out_glyph, out HPS.LinePattern.Cap out_type) |
Shows the end cap for this LinePatternOptionsKit. More... | |
bool | ShowInnerCap (out HPS.LinePattern.Cap out_type) |
Shows the inner cap for this LinePatternOptionsKit. More... | |
bool | ShowJoin (out HPS.LinePattern.Modifier out_modifier, out string out_glyph, out HPS.LinePattern.Join out_type) |
Shows the join for this LinePatternOptionsKit. More... | |
bool | ShowStartCap (out HPS.LinePattern.Modifier out_modifier, out string out_glyph, out HPS.LinePattern.Cap out_type) |
Shows the start cap for this LinePatternOptionsKit. More... | |
HPS.LinePatternOptionsKit | UnsetEndCap () |
Removes the end cap for this LinePatternOptionsKit. This will result in the end cap defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit. More... | |
HPS.LinePatternOptionsKit | UnsetEverything () |
Removes all settings from this LinePatternOptionsKit. More... | |
HPS.LinePatternOptionsKit | UnsetInnerCap () |
Removes the inner cap for this LinePatternOptionsKit. More... | |
HPS.LinePatternOptionsKit | UnsetJoin () |
Removes the join for this LinePatternOptionsKit. This will result in the join defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit. More... | |
HPS.LinePatternOptionsKit | UnsetStartCap () |
Removes the start cap for this LinePatternOptionsKit. This will result in the start cap defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. 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... | |
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... | |
Static Public Member Functions | |
static bool | operator!= (HPS.LinePatternOptionsKit a, HPS.LinePatternOptionsKit b) |
static bool | operator== (HPS.LinePatternOptionsKit a, HPS.LinePatternOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The LinePatternOptionsKit class is a user space object. It is used for specifying (or overriding) some line pattern options when setting a line pattern on a segment.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty LinePatternOptionsKit object.
|
inline |
The copy constructor creates a new LinePatternOptionsKit object that contains the same settings as the source LinePatternOptionsKit.
- Parameters
-
in_kit The source LinePatternOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this LinePatternOptionsKit has any values set on it.
- Returns
- true if no values are set on this LinePatternOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source LinePatternOptionsKit is equivalent to this LinePatternOptionsKit.
- Parameters
-
in_kit The source LinePatternOptionsKit to compare to this LinePatternOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinevirtual |
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.
|
inline |
Copies the source LinePatternOptionsKit into this LinePatternOptionsKit.
- Parameters
-
in_kit The source LinePatternOptionsKit to copy.
|
inline |
Sets the glyph to use as the end cap for the associated line pattern.
- Parameters
-
in_glyph UTF8-encoded name of the glyph to use as the end cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Sets the cap to use as the end cap for the associated line pattern.
- Parameters
-
in_type The type of cap to use as the end cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Sets the cap to use as the inner cap for the associated line pattern.
- Parameters
-
in_type The type of cap to use as the inner cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Sets the glyph to use as the join for the associated line pattern.
- Parameters
-
in_glyph UTF8-encoded name of the glyph to use as the join for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Sets the join to use for the associated line pattern.
- Parameters
-
in_type The type of join to use for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Sets the glyph to use as the start cap for the associated line pattern.
- Parameters
-
in_glyph UTF8-encoded name of the glyph to use as the start cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Sets the cap to use as the start cap for the associated line pattern.
- Parameters
-
in_type The type of cap to use as the start cap for the associated line pattern.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Copies this LinePatternOptionsKit into the given LinePatternOptionsKit.
- Parameters
-
out_kit The LinePatternOptionsKit to populate with the contents of this LinePatternOptionsKit.
|
inline |
Shows the end cap for this LinePatternOptionsKit.
- Parameters
-
out_modifier Indicates which of the following arguments is valid. out_glyph UTF8-encoded name of the glyph to use as the end cap. This is only valid if out_modifier is LinePattern::Modifier::GlyphName. out_type The predefined type of cap to use as the end cap. This is only valid if out_modifier is LinePattern::Modifier::Enumerated.
- Returns
- true if an end cap was set, false otherwise.
|
inline |
Shows the inner cap for this LinePatternOptionsKit.
- Parameters
-
out_type The predefined type of cap to use as the inner cap.
- Returns
- true if an inner cap was set, false otherwise.
|
inline |
Shows the join for this LinePatternOptionsKit.
- Parameters
-
out_modifier Indicates which of the following arguments is valid. out_glyph UTF8-encoded name of the glyph to use as the join. This is only valid if out_modifier is LinePattern::Modifier::GlyphName. out_type The predefined type of join to use. This is only valid if out_modifier is LinePattern::Modifier::Enumerated.
- Returns
- true if a join was set, false otherwise.
|
inline |
Shows the start cap for this LinePatternOptionsKit.
- Parameters
-
out_modifier Indicates which of the following arguments is valid. out_glyph UTF8-encoded name of the glyph to use as the start cap. This is only valid if out_modifier is LinePattern::Modifier::GlyphName. out_type The predefined type of cap to use as the start cap. This is only valid if out_modifier is LinePattern::Modifier::Enumerated.
- Returns
- true if a start cap was set, false otherwise.
|
inline |
Removes the end cap for this LinePatternOptionsKit. This will result in the end cap defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Removes all settings from this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Removes the inner cap for this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Removes the join for this LinePatternOptionsKit. This will result in the join defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
|
inline |
Removes the start cap for this LinePatternOptionsKit. This will result in the start cap defined on the associated line pattern (if any) getting used when set with this LinePatternOptionsKit.
- Returns
- A reference to this LinePatternOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.LinePatternOptionsKit.cs