
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 () |
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... | |
override HPS.Type | Type () |
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. More... | |
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(). More... | |
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(). More... | |
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(). More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
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. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
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
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
inline |
Sets the size of markers.
- Parameters
-
in_size The size for markers. in_units The units of the size for markers.
- Returns
- A reference to this object.
|
inline |
Sets the size of markers.
- Parameters
-
in_size The size for markers.
- Returns
- A reference to this object.
|
inline |
Sets the glyph that should be used to draw markers.
- Parameters
-
in_glyph_name A UTF8 encoded name of a glyph, defined in an accessible portfolio.
- Returns
- A reference to this object.
|
inline |
Shows the size of markers.
- Parameters
-
out_size The size for markers. out_units The units of the size for markers.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the glyph that should be used to draw markers.
- Parameters
-
out_glyph_name A UTF8 encoded name of a glyph, defined in an accessible portfolio.
- Returns
- true if the setting is valid, false otherwise.
|
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
|
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.
|
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.
|
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