HPS.MarkerAttributeControl Class Reference
Inheritance diagram for HPS.MarkerAttributeControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
 MarkerAttributeControl (HPS.SegmentKey in_seg)
 
 MarkerAttributeControl (HPS.MarkerAttributeControl in_that)
 
override HPS.Type ObjectType ()
 
HPS.MarkerAttributeControl SetDrawingPreference (HPS.Marker.DrawingPreference in_preference)
 
HPS.MarkerAttributeControl SetGlyphRotation (float in_rotation)
 
HPS.MarkerAttributeControl SetSize (float in_size, HPS.Marker.SizeUnits in_units)
 
HPS.MarkerAttributeControl SetSize (float in_size)
 
HPS.MarkerAttributeControl SetSymbol (string in_glyph_name)
 
bool ShowDrawingPreference (out HPS.Marker.DrawingPreference out_preference)
 
bool ShowGlyphRotation (out float out_rotation)
 
bool ShowSize (out float out_size, out HPS.Marker.SizeUnits out_units)
 
bool ShowSymbol (out string out_glyph_name)
 
override HPS.Type Type ()
 
HPS.MarkerAttributeControl UnsetDrawingPreference ()
 
HPS.MarkerAttributeControl UnsetEverything ()
 
HPS.MarkerAttributeControl UnsetGlyphRotation ()
 
HPS.MarkerAttributeControl UnsetSize ()
 
HPS.MarkerAttributeControl UnsetSymbol ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ MarkerAttributeControl() [1/2]

HPS.MarkerAttributeControl.MarkerAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ MarkerAttributeControl() [2/2]

HPS.MarkerAttributeControl.MarkerAttributeControl ( HPS.MarkerAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.MarkerAttributeControl.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.Control.

◆ SetDrawingPreference()

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.SetDrawingPreference ( HPS.Marker.DrawingPreference  in_preference)
inline

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

Parameters
in_preferenceThe preferred drawing style.
Returns
A reference to this object.

◆ SetGlyphRotation()

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.SetGlyphRotation ( float  in_rotation)
inline

Sets the glyph rotation option.

Parameters
in_rotationThe rotation for glyphs.
Returns
A reference to this object.

◆ SetSize() [1/2]

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.SetSize ( float  in_size,
HPS.Marker.SizeUnits  in_units 
)
inline

Sets the size of markers.

Parameters
in_sizeThe size for markers.
in_unitsThe units of the size for markers.
Returns
A reference to this object.

◆ SetSize() [2/2]

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.SetSize ( float  in_size)
inline

Sets the size of markers.

Parameters
in_sizeThe size for markers.
Returns
A reference to this object.

◆ SetSymbol()

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.SetSymbol ( string  in_glyph_name)
inline

Sets the glyph that should be used to draw markers.

Parameters
in_glyph_nameA UTF8 encoded name of a glyph, defined in an accessible portfolio.
Returns
A reference to this object.

◆ ShowDrawingPreference()

bool HPS.MarkerAttributeControl.ShowDrawingPreference ( out HPS.Marker.DrawingPreference  out_preference)
inline

Shows the drawing method for markers.

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

◆ ShowGlyphRotation()

bool HPS.MarkerAttributeControl.ShowGlyphRotation ( out float  out_rotation)
inline

Shows the glyph rotation.

Parameters
out_rotationThe rotation value. return true if the setting is valid, false otherwise.

◆ ShowSize()

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

Shows the size of markers.

Parameters
out_sizeThe size for markers.
out_unitsThe units of the size for markers.
Returns
true if the setting is valid, false otherwise.

◆ ShowSymbol()

bool HPS.MarkerAttributeControl.ShowSymbol ( out string  out_glyph_name)
inline

Shows the glyph that should be used to draw markers.

Parameters
out_glyph_nameA UTF8 encoded name of a glyph, defined in an accessible portfolio.
Returns
true if the setting is valid, false otherwise.

◆ Type()

override HPS.Type HPS.MarkerAttributeControl.Type ( )
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetDrawingPreference()

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.UnsetDrawingPreference ( )
inline

Removes the drawing preference setting

Returns
A reference to this object.

◆ UnsetEverything()

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.UnsetEverything ( )
inline

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

Returns
A reference to this object.

◆ UnsetGlyphRotation()

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.UnsetGlyphRotation ( )
inline

Removes the glyph rotation setting

Returns
A reference to this object.

◆ UnsetSize()

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.UnsetSize ( )
inline

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

Returns
A reference to this object.

◆ UnsetSymbol()

HPS.MarkerAttributeControl HPS.MarkerAttributeControl.UnsetSymbol ( )
inline

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

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.MarkerAttributeControl.cs