
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.MarkerAttributeKit in_kit) |
Check if the source MarkerAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
MarkerAttributeKit () | |
Initializes an empty kit. More... | |
MarkerAttributeKit (HPS.MarkerAttributeKit in_kit) | |
The copy constructor creates a new MarkerAttributeKit object that contains the same settings as the source object. More... | |
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). More... | |
void | Set (HPS.MarkerAttributeKit in_kit) |
Copies all settings from the source MarkerAttributeKit into this object. More... | |
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. More... | |
HPS.MarkerAttributeKit | SetGlyphRotation (float in_rotation) |
Sets the glyph rotation option. More... | |
HPS.MarkerAttributeKit | SetSize (float in_size, HPS.Marker.SizeUnits in_units) |
Sets the size of markers. More... | |
HPS.MarkerAttributeKit | SetSize (float in_size) |
Sets the size of markers. More... | |
HPS.MarkerAttributeKit | SetSymbol (string in_glyph_name) |
Sets the glyph used to represent markers. More... | |
void | Show (out HPS.MarkerAttributeKit out_kit) |
Copies all settings from this MarkerAttributeKit into the given MarkerAttributeKit. More... | |
bool | ShowDrawingPreference (out HPS.Marker.DrawingPreference out_preference) |
Shows the drawing method for markers. More... | |
bool | ShowGlyphRotation (out float out_rotation) |
Shows the glyph rotation option. 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.MarkerAttributeKit | UnsetDrawingPreference () |
Removes the drawing preference setting More... | |
HPS.MarkerAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.MarkerAttributeKit | UnsetGlyphRotation () |
Removes the glyph rotation setting More... | |
HPS.MarkerAttributeKit | UnsetSize () |
Removes the marker size setting. More... | |
HPS.MarkerAttributeKit | UnsetSymbol () |
Removes the marker symbol setting. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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... | |
Static Public Member Functions | |
static 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. More... | |
static bool | operator!= (HPS.MarkerAttributeKit a, HPS.MarkerAttributeKit b) |
static bool | operator== (HPS.MarkerAttributeKit a, HPS.MarkerAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
◆ MarkerAttributeKit() [1/2]
|
inline |
Initializes an empty kit.
◆ MarkerAttributeKit() [2/2]
|
inline |
The copy constructor creates a new MarkerAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
◆ Empty()
|
inlinevirtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS.Object.
◆ Equals()
|
inline |
Check if the source MarkerAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source MarkerAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
inlinestatic |
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.
- Returns
- A MarkerAttributeKit with the default settings.
◆ 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.Kit.
◆ Set()
|
inline |
Copies all settings from the source MarkerAttributeKit into this object.
- Parameters
-
in_kit The source MarkerAttributeKit to copy.
◆ SetDrawingPreference()
|
inline |
Sets the drawing method for markers. Fastest will draw at requested size, unless that would incur performance cost. Nicest will anyway.
- Parameters
-
in_preference The preferred drawing style.
- Returns
- A reference to this object.
◆ SetGlyphRotation()
|
inline |
Sets the glyph rotation option.
- Parameters
-
in_rotation The rotation for glyphs.
- Returns
- A reference to this object.
◆ SetSize() [1/2]
|
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.
◆ SetSize() [2/2]
|
inline |
Sets the size of markers.
- Parameters
-
in_size The size for markers.
- Returns
- A reference to this object.
◆ SetSymbol()
|
inline |
Sets the glyph used to represent markers.
- Parameters
-
in_glyph_name A UTF8 encoded name of a glyph, defined in an accessible portfolio.
- Returns
- A reference to this object.
◆ Show()
|
inline |
Copies all settings from this MarkerAttributeKit into the given MarkerAttributeKit.
- Parameters
-
out_kit The MarkerAttributeKit to populate with the contents of this object.
◆ ShowDrawingPreference()
|
inline |
Shows the drawing method for markers.
- Parameters
-
out_preference The preferred drawing style. return true if the setting is valid, false otherwise.
◆ ShowGlyphRotation()
|
inline |
Shows the glyph rotation option.
- Parameters
-
out_rotation The glyph rotation option in degrees. return true if the setting is valid, false otherwise.
◆ ShowSize()
|
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.
◆ ShowSymbol()
|
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.
◆ UnsetDrawingPreference()
|
inline |
Removes the drawing preference setting
- Returns
- A reference to this object.
◆ UnsetEverything()
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetGlyphRotation()
|
inline |
Removes the glyph rotation setting
- Returns
- A reference to this object.
◆ UnsetSize()
|
inline |
Removes the marker size setting.
- Returns
- A reference to this object.
◆ UnsetSymbol()
|
inline |
Removes the marker symbol setting.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.MarkerAttributeKit.cs