MarkerAttributeKit

class HPS.MarkerAttributeKit : public HPS.Kit

The HPS.MarkerAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS.MarkerAttributeKit.GetDefault() will return a kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this object has any values set on it.

Return

true if no values are set on this object, false otherwise.

bool Equals (HPS.MarkerAttributeKit in_kit)

Check if the source MarkerAttributeKit is equivalent to this object.

Param in_kit

The source MarkerAttributeKit to compare to this object.

Return

true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

MarkerAttributeKit ()

Initializes an empty kit.

MarkerAttributeKit (HPS.MarkerAttributeKit in_kit)

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

Param in_kit

The source object 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.MarkerAttributeKit in_kit)

Copies all settings from the source MarkerAttributeKit into this object.

Param in_kit

The source MarkerAttributeKit to copy.

HPS.MarkerAttributeKit SetDrawingPreference (HPS.Marker.DrawingPreference in_preference)

Sets the drawing method for markers. Fastest will draw at requested size, unless that would incur performance cost. Nicest will anyway.

Param in_preference

The preferred drawing style.

Return

A reference to this object.

HPS.MarkerAttributeKit SetGlyphRotation (float in_rotation)

Sets the glyph rotation option.

Param in_rotation

The rotation for glyphs.

Return

A reference to this object.

HPS.MarkerAttributeKit SetSize (float in_size)

Sets the size of markers.

Param in_size

The size for markers.

Return

A reference to this object.

HPS.MarkerAttributeKit SetSize (float in_size, HPS.Marker.SizeUnits in_units)

Sets the size of markers.

Param in_size

The size for markers.

Param in_units

The units of the size for markers.

Return

A reference to this object.

HPS.MarkerAttributeKit SetSymbol (string in_glyph_name)

Sets the glyph used to represent markers.

Param in_glyph_name

A UTF8 encoded name of a glyph, defined in an accessible portfolio.

Return

A reference to this object.

void Show (out HPS.MarkerAttributeKit out_kit)

Copies all settings from this MarkerAttributeKit into the given MarkerAttributeKit.

Param out_kit

The MarkerAttributeKit to populate with the contents of this object.

bool ShowDrawingPreference (out HPS.Marker.DrawingPreference out_preference)

Shows the drawing method for markers.

Param out_preference

The preferred drawing style. return true if the setting is valid, false otherwise.

bool ShowGlyphRotation (out float out_rotation)

Shows the glyph rotation option.

Param out_rotation

The glyph rotation option in degrees. return true if the setting is valid, false otherwise.

bool ShowSize (out float out_size, out HPS.Marker.SizeUnits out_units)

Shows the size of markers.

Param out_size

The size for markers.

Param out_units

The units of the size for markers.

Return

true if the setting is valid, false otherwise.

bool ShowSymbol (out string out_glyph_name)

Shows the glyph that should be used to draw markers.

Param out_glyph_name

A UTF8 encoded name of a glyph, defined in an accessible portfolio.

Return

true if the setting is valid, false otherwise.

HPS.MarkerAttributeKit UnsetDrawingPreference ()

Removes the drawing preference setting

Return

A reference to this object.

HPS.MarkerAttributeKit UnsetEverything ()

Removes all settings from this object.

Return

A reference to this object.

HPS.MarkerAttributeKit UnsetGlyphRotation ()

Removes the glyph rotation setting

Return

A reference to this object.

HPS.MarkerAttributeKit UnsetSize ()

Removes the marker size setting.

Return

A reference to this object.

HPS.MarkerAttributeKit UnsetSymbol ()

Removes the marker symbol setting.

Return

A reference to this object.

Public Static Functions

HPS.MarkerAttributeKit GetDefault ()

Creates a MarkerAttributeKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Return

A MarkerAttributeKit with the default settings.

bool operator!= (HPS.MarkerAttributeKit a, HPS.MarkerAttributeKit b)

bool operator== (HPS.MarkerAttributeKit a, HPS.MarkerAttributeKit b)