MarkerAttributeControl

class HPS.MarkerAttributeControl : public HPS.Control

The HPS.MarkerAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the marker size and symbol at the segment level.

This table lists default values for the various segment attributes accessible from HPS.MarkerAttributeControl.

Public Functions

override void Dispose ()

MarkerAttributeControl (HPS.MarkerAttributeControl in_that)

Initializes a control tied to the same object as in_that.

MarkerAttributeControl (HPS.SegmentKey in_seg)

Initializes a control tied to the segment in_seg.

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.

HPS.MarkerAttributeControl 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.MarkerAttributeControl SetGlyphRotation (float in_rotation)

Sets the glyph rotation option.

Param in_rotation

The rotation for glyphs.

Return

A reference to this object.

HPS.MarkerAttributeControl SetSize (float in_size)

Sets the size of markers.

Param in_size

The size for markers.

Return

A reference to this object.

HPS.MarkerAttributeControl 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.MarkerAttributeControl SetSymbol (string in_glyph_name)

Sets the glyph that should be used to draw markers.

Param in_glyph_name

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

Return

A reference to 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.

Param out_rotation

The rotation value. 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.MarkerAttributeControl UnsetDrawingPreference ()

Removes the drawing preference setting

Return

A reference to this object.

HPS.MarkerAttributeControl UnsetEverything ()

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by MarkerAttributeKit.GetDefault().

Return

A reference to this object.

HPS.MarkerAttributeControl UnsetGlyphRotation ()

Removes the glyph rotation setting

Return

A reference to this object.

HPS.MarkerAttributeControl UnsetSize ()

Removes the marker size setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MarkerAttributeKit.GetDefault().

Return

A reference to this object.

HPS.MarkerAttributeControl UnsetSymbol ()

Removes the marker symbol setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by MarkerAttributeKit.GetDefault().

Return

A reference to this object.