< Home

< Table of Contents

REFERENCE MANUAL

HPS.MarkerAttributeControl Class Reference

The MarkerAttributeControl class is a smart pointer that is tied to a database object. More...

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

Public Member Functions

override void Dispose ()
 
 MarkerAttributeControl (HPS.SegmentKey in_seg)
 Initializes a control tied to the segment in_seg. More...
 
 MarkerAttributeControl (HPS.MarkerAttributeControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.MarkerAttributeControl SetSize (float in_size, HPS.Marker.SizeUnits in_units)
 Sets the size of markers. More...
 
HPS.MarkerAttributeControl SetSize (float in_size)
 Sets the size of markers. More...
 
HPS.MarkerAttributeControl SetSymbol (string in_glyph_name)
 Sets the glyph that should be used to draw markers. More...
 
bool ShowSize (out float out_size, out HPS.Marker.SizeUnits out_units)
 Shows the size of markers. More...
 
bool ShowSymbol (out string out_glyph_name)
 Shows the glyph that should be used to draw markers. More...
 
HPS.MarkerAttributeControl UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.MarkerAttributeControl UnsetSize ()
 Removes the marker size setting. More...
 
HPS.MarkerAttributeControl UnsetSymbol ()
 Removes the marker symbol setting. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

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
 
HandleRef scptr
 

Detailed Description

The 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 MarkerAttributeControl.

Constructor & Destructor Documentation

HPS.MarkerAttributeControl.MarkerAttributeControl ( HPS.SegmentKey  in_seg)

Initializes a control tied to the segment in_seg.

HPS.MarkerAttributeControl.MarkerAttributeControl ( HPS.MarkerAttributeControl  in_that)

Initializes a control tied to the same object as in_that.

Member Function Documentation

override HPS.Type HPS.MarkerAttributeControl.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

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

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.
HPS.MarkerAttributeControl HPS.MarkerAttributeControl.SetSize ( float  in_size)

Sets the size of markers.

Parameters
in_sizeThe size for markers.
Returns
A reference to this object.
HPS.MarkerAttributeControl HPS.MarkerAttributeControl.SetSymbol ( string  in_glyph_name)

Sets the glyph that should be used to draw markers.

Parameters
in_glyph_nameA <ref refid="class_h_p_s_1_1_u_t_f8" kindref="compound">UTF8</ref> encoded name of a glyph, defined in an accessible portfolio.
Returns
A reference to this object.
bool HPS.MarkerAttributeControl.ShowSize ( out float  out_size,
out HPS.Marker.SizeUnits  out_units 
)

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.
bool HPS.MarkerAttributeControl.ShowSymbol ( out string  out_glyph_name)

Shows the glyph that should be used to draw markers.

Parameters
out_glyph_nameA <ref refid="class_h_p_s_1_1_u_t_f8" kindref="compound">UTF8</ref> encoded name of a glyph, defined in an accessible portfolio.
Returns
true if the setting is valid, false otherwise.
HPS.MarkerAttributeControl HPS.MarkerAttributeControl.UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
HPS.MarkerAttributeControl HPS.MarkerAttributeControl.UnsetSize ( )

Removes the marker size setting.

Returns
A reference to this object.
HPS.MarkerAttributeControl HPS.MarkerAttributeControl.UnsetSymbol ( )

Removes the marker symbol setting.

Returns
A reference to this object.

The documentation for this class was generated from the following file: