Inheritance diagram for HPS.MarkerAttributeKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.MarkerAttributeKit in_kit)
 
override int GetHashCode ()
 
 MarkerAttributeKit ()
 
 MarkerAttributeKit (HPS.MarkerAttributeKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.MarkerAttributeKit in_kit)
 
HPS.MarkerAttributeKit SetDrawingPreference (HPS.Marker.DrawingPreference in_preference)
 
HPS.MarkerAttributeKit SetGlyphRotation (float in_rotation)
 
HPS.MarkerAttributeKit SetSize (float in_size, HPS.Marker.SizeUnits in_units)
 
HPS.MarkerAttributeKit SetSize (float in_size)
 
HPS.MarkerAttributeKit SetSymbol (string in_glyph_name)
 
void Show (out HPS.MarkerAttributeKit out_kit)
 
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)
 
HPS.MarkerAttributeKit UnsetDrawingPreference ()
 
HPS.MarkerAttributeKit UnsetEverything ()
 
HPS.MarkerAttributeKit UnsetGlyphRotation ()
 
HPS.MarkerAttributeKit UnsetSize ()
 
HPS.MarkerAttributeKit UnsetSymbol ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.MarkerAttributeKit GetDefault ()
 
static bool operator!= (HPS.MarkerAttributeKit a, HPS.MarkerAttributeKit b)
 
static bool operator== (HPS.MarkerAttributeKit a, HPS.MarkerAttributeKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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]

HPS.MarkerAttributeKit.MarkerAttributeKit ( )
inline

Initializes an empty kit.

◆ MarkerAttributeKit() [2/2]

HPS.MarkerAttributeKit.MarkerAttributeKit ( HPS.MarkerAttributeKit  in_kit)
inline

The copy constructor creates a new MarkerAttributeKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.MarkerAttributeKit.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()

bool HPS.MarkerAttributeKit.Equals ( HPS.MarkerAttributeKit  in_kit)
inline

Check if the source MarkerAttributeKit is equivalent to this object.

Parameters
in_kitThe source MarkerAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.MarkerAttributeKit HPS.MarkerAttributeKit.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()

override HPS.Type HPS.MarkerAttributeKit.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()

void HPS.MarkerAttributeKit.Set ( HPS.MarkerAttributeKit  in_kit)
inline

Copies all settings from the source MarkerAttributeKit into this object.

Parameters
in_kitThe source MarkerAttributeKit to copy.

◆ SetDrawingPreference()

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

Sets the size of markers.

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

◆ SetSymbol()

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

Sets the glyph used to represent markers.

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

◆ Show()

void HPS.MarkerAttributeKit.Show ( out HPS.MarkerAttributeKit  out_kit)
inline

Copies all settings from this MarkerAttributeKit into the given MarkerAttributeKit.

Parameters
out_kitThe MarkerAttributeKit to populate with the contents of this object.

◆ ShowDrawingPreference()

bool HPS.MarkerAttributeKit.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.MarkerAttributeKit.ShowGlyphRotation ( out float  out_rotation)
inline

Shows the glyph rotation option.

Parameters
out_rotationThe glyph rotation option in degrees. return true if the setting is valid, false otherwise.

◆ ShowSize()

bool HPS.MarkerAttributeKit.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.MarkerAttributeKit.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.

◆ UnsetDrawingPreference()

HPS.MarkerAttributeKit HPS.MarkerAttributeKit.UnsetDrawingPreference ( )
inline

Removes the drawing preference setting

Returns
A reference to this object.

◆ UnsetEverything()

HPS.MarkerAttributeKit HPS.MarkerAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetGlyphRotation()

HPS.MarkerAttributeKit HPS.MarkerAttributeKit.UnsetGlyphRotation ( )
inline

Removes the glyph rotation setting

Returns
A reference to this object.

◆ UnsetSize()

HPS.MarkerAttributeKit HPS.MarkerAttributeKit.UnsetSize ( )
inline

Removes the marker size setting.

Returns
A reference to this object.

◆ UnsetSymbol()

HPS.MarkerAttributeKit HPS.MarkerAttributeKit.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