MarkerKey
- class HPS.MarkerKey : public HPS.GeometryKey
The MarkerKey class is a smart pointer to a database object. It is a handle to a marker inserted via SegmentKey.InsertMarker.
Public Functions
- void Consume (HPS.MarkerKit in_kit)
Completely replaces all settings on this MarkerKey with those set on the specified kit and resets the kit.
- Param in_kit
The kit from which to get the settings to replace on this MarkerKey.
- override void Dispose ()
- MarkerKey ()
The default constructor creates an uninitialized MarkerKey object. The Type() function will return Type.None.
- MarkerKey (HPS.Key in_that)
This constructor creates a MarkerKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of a Marker key. Otherwise the copy will fail and the resulting MarkerKey will be invalid.
- Param in_that
The source Key to copy.
- MarkerKey (HPS.MarkerKey in_that)
The copy constructor creates a MarkerKey object that shares the underlying smart-pointer of the source MarkerKey.
- Param in_that
The source MarkerKey to copy.
- 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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void Set (HPS.MarkerKit in_kit)
Replace those settings on this MarkerKey with those set on the specified kit.
- Param in_kit
The kit from which to get the settings to replace on this MarkerKey.
- HPS.MarkerKey SetPoint (HPS.Point in_point)
Sets the point for this MarkerKey.
- void Show (out HPS.MarkerKit out_kit)
Copy the contents of this MarkerKey into the specified kit.
- Param out_kit
The kit to populate with the contents of this MarkerKey.
