|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static bool | operator!= (HPS.Key a, HPS.Key b) |
|
static bool | operator== (HPS.Key a, HPS.Key b) |
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The MarkerKey class is a smart pointer to a database object. It is a handle to a marker inserted via SegmentKey.InsertMarker.
◆ MarkerKey() [1/3]
HPS.MarkerKey.MarkerKey |
( |
| ) |
|
|
inline |
The default constructor creates an uninitialized MarkerKey object. The Type() function will return Type.None.
◆ MarkerKey() [2/3]
HPS.MarkerKey.MarkerKey |
( |
HPS.Key |
in_that | ) |
|
|
inline |
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.
- Parameters
-
in_that | The source Key to copy. |
◆ MarkerKey() [3/3]
The copy constructor creates a MarkerKey object that shares the underlying smart-pointer of the source MarkerKey.
- Parameters
-
◆ Consume()
Completely replaces all settings on this MarkerKey with those set on the specified kit and resets the kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this MarkerKey. |
◆ ObjectType()
override HPS.Type HPS.MarkerKey.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.GeometryKey.
◆ Set()
Replace those settings on this MarkerKey with those set on the specified kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this MarkerKey. |
◆ SetPoint()
◆ Show()
Copy the contents of this MarkerKey into the specified kit.
- Parameters
-
out_kit | The kit to populate with the contents of this MarkerKey. |
◆ ShowPoint()
bool HPS.MarkerKey.ShowPoint |
( |
out HPS.Point |
out_point | ) |
|
|
inline |
Shows the point for this MarkerKey.
- Parameters
-
- Returns
- true if a point was set, false otherwise.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.MarkerKey.cs