LinePatternOptionsKit

class HPS.LinePatternOptionsKit : public HPS.Kit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this LinePatternOptionsKit has any values set on it.

Return: true if no values are set on this LinePatternOptionsKit, false otherwise.

bool Equals (HPS.LinePatternOptionsKit in_kit)

Check if the source LinePatternOptionsKit is equivalent to this LinePatternOptionsKit.

Param in_kit: The source LinePatternOptionsKit to compare to this LinePatternOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

LinePatternOptionsKit (): The default constructor creates an empty LinePatternOptionsKit object.

LinePatternOptionsKit (HPS.LinePatternOptionsKit in_kit)

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

Param in_kit: The source LinePatternOptionsKit to copy.

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).

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

void Set (HPS.LinePatternOptionsKit in_kit)

Copies the source LinePatternOptionsKit into this LinePatternOptionsKit.

Param in_kit: The source LinePatternOptionsKit to copy.

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

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

Param in_type: The type of cap to use as the end cap for the associated line pattern.
Return: A reference to this LinePatternOptionsKit.

HPS.LinePatternOptionsKit SetEndCap (string in_glyph)

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

Param in_glyph: UTF8-encoded name of the glyph to use as the end cap for the associated line pattern.
Return: A reference to this LinePatternOptionsKit.

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

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

Param in_type: The type of cap to use as the inner cap for the associated line pattern.
Return: A reference to this LinePatternOptionsKit.

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

Sets the join to use for the associated line pattern.

Param in_type: The type of join to use for the associated line pattern.
Return: A reference to this LinePatternOptionsKit.

HPS.LinePatternOptionsKit SetJoin (string in_glyph)

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

Param in_glyph: UTF8-encoded name of the glyph to use as the join for the associated line pattern.
Return: A reference to this LinePatternOptionsKit.

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

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

Param in_type: The type of cap to use as the start cap for the associated line pattern.
Return: A reference to this LinePatternOptionsKit.

HPS.LinePatternOptionsKit SetStartCap (string in_glyph)

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

Param in_glyph: UTF8-encoded name of the glyph to use as the start cap for the associated line pattern.
Return: A reference to this LinePatternOptionsKit.

void Show (out HPS.LinePatternOptionsKit out_kit)

Copies this LinePatternOptionsKit into the given LinePatternOptionsKit.

Param out_kit: The LinePatternOptionsKit to populate with the contents of this LinePatternOptionsKit.

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.

Param out_modifier: Indicates which of the following arguments is valid.
Param 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.
Param out_type: The predefined type of cap to use as the end cap. This is only valid if out_modifier is LinePattern.Modifier.Enumerated.
Return: true if an end cap was set, false otherwise.

bool ShowInnerCap (out HPS.LinePattern.Cap out_type)

Shows the inner cap for this LinePatternOptionsKit.

Param out_type: The predefined type of cap to use as the inner cap.
Return: true if an inner cap was set, false otherwise.

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

Shows the join for this LinePatternOptionsKit.

Param out_modifier: Indicates which of the following arguments is valid.
Param out_glyph: UTF8-encoded name of the glyph to use as the join. This is only valid if out_modifier is LinePattern.Modifier.GlyphName.
Param out_type: The predefined type of join to use. This is only valid if out_modifier is LinePattern.Modifier.Enumerated.
Return: true if a join was set, false otherwise.

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.

Param out_modifier: Indicates which of the following arguments is valid.
Param 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.
Param out_type: The predefined type of cap to use as the start cap. This is only valid if out_modifier is LinePattern.Modifier.Enumerated.
Return: true if a start cap was set, false otherwise.

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.

Return: A reference to this LinePatternOptionsKit.

HPS.LinePatternOptionsKit UnsetEverything ()

Removes all settings from this LinePatternOptionsKit.

Return: A reference to this LinePatternOptionsKit.

HPS.LinePatternOptionsKit UnsetInnerCap ()

Removes the inner cap for this LinePatternOptionsKit.

Return: A reference to this LinePatternOptionsKit.

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.

Return: A reference to this LinePatternOptionsKit.

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.

Return: A reference to this LinePatternOptionsKit.

Public Static Functions

bool operator!= (HPS.LinePatternOptionsKit a, HPS.LinePatternOptionsKit b)

bool operator== (HPS.LinePatternOptionsKit a, HPS.LinePatternOptionsKit b)