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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.LinePatternOptionsKit in_kit)
 
override int GetHashCode ()
 
 LinePatternOptionsKit ()
 
 LinePatternOptionsKit (HPS.LinePatternOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.LinePatternOptionsKit in_kit)
 
HPS.LinePatternOptionsKit SetEndCap (string in_glyph)
 
HPS.LinePatternOptionsKit SetEndCap (HPS.LinePattern.Cap in_type)
 
HPS.LinePatternOptionsKit SetInnerCap (HPS.LinePattern.Cap in_type)
 
HPS.LinePatternOptionsKit SetJoin (string in_glyph)
 
HPS.LinePatternOptionsKit SetJoin (HPS.LinePattern.Join in_type)
 
HPS.LinePatternOptionsKit SetStartCap (string in_glyph)
 
HPS.LinePatternOptionsKit SetStartCap (HPS.LinePattern.Cap in_type)
 
void Show (out HPS.LinePatternOptionsKit out_kit)
 
bool ShowEndCap (out HPS.LinePattern.Modifier out_modifier, out string out_glyph, out HPS.LinePattern.Cap out_type)
 
bool ShowInnerCap (out HPS.LinePattern.Cap out_type)
 
bool ShowJoin (out HPS.LinePattern.Modifier out_modifier, out string out_glyph, out HPS.LinePattern.Join out_type)
 
bool ShowStartCap (out HPS.LinePattern.Modifier out_modifier, out string out_glyph, out HPS.LinePattern.Cap out_type)
 
HPS.LinePatternOptionsKit UnsetEndCap ()
 
HPS.LinePatternOptionsKit UnsetEverything ()
 
HPS.LinePatternOptionsKit UnsetInnerCap ()
 
HPS.LinePatternOptionsKit UnsetJoin ()
 
HPS.LinePatternOptionsKit UnsetStartCap ()
 
- 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.LinePatternOptionsKit a, HPS.LinePatternOptionsKit b)
 
static bool operator== (HPS.LinePatternOptionsKit a, HPS.LinePatternOptionsKit 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 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

◆ LinePatternOptionsKit() [1/2]

HPS.LinePatternOptionsKit.LinePatternOptionsKit ( )
inline

The default constructor creates an empty LinePatternOptionsKit object.

◆ LinePatternOptionsKit() [2/2]

HPS.LinePatternOptionsKit.LinePatternOptionsKit ( HPS.LinePatternOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source LinePatternOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.LinePatternOptionsKit.Empty ( )
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.

◆ Equals()

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

Check if the source LinePatternOptionsKit is equivalent to this LinePatternOptionsKit.

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

◆ ObjectType()

override HPS.Type HPS.LinePatternOptionsKit.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.LinePatternOptionsKit.Set ( HPS.LinePatternOptionsKit  in_kit)
inline

Copies the source LinePatternOptionsKit into this LinePatternOptionsKit.

Parameters
in_kitThe source LinePatternOptionsKit to copy.

◆ SetEndCap() [1/2]

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.SetEndCap ( string  in_glyph)
inline

Sets the glyph to use as the end cap for the associated line pattern.

Parameters
in_glyphUTF8-encoded name of the glyph to use as the end cap for the associated line pattern.
Returns
A reference to this LinePatternOptionsKit.

◆ SetEndCap() [2/2]

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.SetEndCap ( HPS.LinePattern.Cap  in_type)
inline

Sets the cap to use as the end cap for the associated line pattern.

Parameters
in_typeThe type of cap to use as the end cap for the associated line pattern.
Returns
A reference to this LinePatternOptionsKit.

◆ SetInnerCap()

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.SetInnerCap ( HPS.LinePattern.Cap  in_type)
inline

Sets the cap to use as the inner cap for the associated line pattern.

Parameters
in_typeThe type of cap to use as the inner cap for the associated line pattern.
Returns
A reference to this LinePatternOptionsKit.

◆ SetJoin() [1/2]

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.SetJoin ( string  in_glyph)
inline

Sets the glyph to use as the join for the associated line pattern.

Parameters
in_glyphUTF8-encoded name of the glyph to use as the join for the associated line pattern.
Returns
A reference to this LinePatternOptionsKit.

◆ SetJoin() [2/2]

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.SetJoin ( HPS.LinePattern.Join  in_type)
inline

Sets the join to use for the associated line pattern.

Parameters
in_typeThe type of join to use for the associated line pattern.
Returns
A reference to this LinePatternOptionsKit.

◆ SetStartCap() [1/2]

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.SetStartCap ( string  in_glyph)
inline

Sets the glyph to use as the start cap for the associated line pattern.

Parameters
in_glyphUTF8-encoded name of the glyph to use as the start cap for the associated line pattern.
Returns
A reference to this LinePatternOptionsKit.

◆ SetStartCap() [2/2]

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.SetStartCap ( HPS.LinePattern.Cap  in_type)
inline

Sets the cap to use as the start cap for the associated line pattern.

Parameters
in_typeThe type of cap to use as the start cap for the associated line pattern.
Returns
A reference to this LinePatternOptionsKit.

◆ Show()

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

Copies this LinePatternOptionsKit into the given LinePatternOptionsKit.

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

◆ ShowEndCap()

bool HPS.LinePatternOptionsKit.ShowEndCap ( out HPS.LinePattern.Modifier  out_modifier,
out string  out_glyph,
out HPS.LinePattern.Cap  out_type 
)
inline

Shows the end cap for this LinePatternOptionsKit.

Parameters
out_modifierIndicates which of the following arguments is valid.
out_glyphUTF8-encoded name of the glyph to use as the end cap. This is only valid if out_modifier is LinePattern.Modifier.GlyphName.
out_typeThe 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.

◆ ShowInnerCap()

bool HPS.LinePatternOptionsKit.ShowInnerCap ( out HPS.LinePattern.Cap  out_type)
inline

Shows the inner cap for this LinePatternOptionsKit.

Parameters
out_typeThe predefined type of cap to use as the inner cap.
Returns
true if an inner cap was set, false otherwise.

◆ ShowJoin()

bool HPS.LinePatternOptionsKit.ShowJoin ( out HPS.LinePattern.Modifier  out_modifier,
out string  out_glyph,
out HPS.LinePattern.Join  out_type 
)
inline

Shows the join for this LinePatternOptionsKit.

Parameters
out_modifierIndicates which of the following arguments is valid.
out_glyphUTF8-encoded name of the glyph to use as the join. This is only valid if out_modifier is LinePattern.Modifier.GlyphName.
out_typeThe 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.

◆ ShowStartCap()

bool HPS.LinePatternOptionsKit.ShowStartCap ( out HPS.LinePattern.Modifier  out_modifier,
out string  out_glyph,
out HPS.LinePattern.Cap  out_type 
)
inline

Shows the start cap for this LinePatternOptionsKit.

Parameters
out_modifierIndicates which of the following arguments is valid.
out_glyphUTF8-encoded name of the glyph to use as the start cap. This is only valid if out_modifier is LinePattern.Modifier.GlyphName.
out_typeThe 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.

◆ UnsetEndCap()

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.UnsetEndCap ( )
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.

◆ UnsetEverything()

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.UnsetEverything ( )
inline

Removes all settings from this LinePatternOptionsKit.

Returns
A reference to this LinePatternOptionsKit.

◆ UnsetInnerCap()

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.UnsetInnerCap ( )
inline

Removes the inner cap for this LinePatternOptionsKit.

Returns
A reference to this LinePatternOptionsKit.

◆ UnsetJoin()

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.UnsetJoin ( )
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.

◆ UnsetStartCap()

HPS.LinePatternOptionsKit HPS.LinePatternOptionsKit.UnsetStartCap ( )
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