MarkerKey
-
class
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(MarkerKit &in_kit) 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.
-
MarkerKey() The default constructor creates an uninitialized MarkerKey object. The Type() function will return Type::None.
-
explicit
MarkerKey(Key const &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.
Parameters: in_that – The source Key to copy.
-
MarkerKey(MarkerKey &&in_that) The move constructor creates a MarkerKey by transferring the underlying impl of the rvalue reference to this MarkerKey thereby avoiding a copy and allocation.
Parameters: in_that – An rvalue reference to a MarkerKey to take the impl from.
-
MarkerKey(MarkerKey const &in_that) The copy constructor creates a MarkerKey object that shares the underlying smart-pointer of the source MarkerKey.
Parameters: in_that – The source MarkerKey to copy.
-
inline virtual HPS::Type
ObjectType() const 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.
-
MarkerKey &
operator=(MarkerKey &&in_that) The move assignment operator transfers the underlying impl of the rvalue reference to this MarkerKey thereby avoiding a copy.
Parameters: in_that – An rvalue reference to a MarkerKey to take the impl from. Returns: A reference to this MarkerKey.
-
MarkerKey &
operator=(MarkerKey const &in_that) Associate this MarkerKey with the same underlying impl as the source MarkerKey.
Parameters: in_that – The source MarkerKey for the assignment. Returns: A reference to this MarkerKey.
-
void
Set(MarkerKit const &in_kit) 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.
-
MarkerKey &
SetPoint(Point const &in_point) Sets the point for this MarkerKey.
Parameters: in_point – The point for this MarkerKey. Returns: A reference to this MarkerKey.
-
void
Show(MarkerKit &out_kit) const Copy the contents of this MarkerKey into the specified kit.
Parameters: out_kit – The kit to populate with the contents of this MarkerKey.
-
bool
ShowPoint(Point &out_point) const Shows the point for this MarkerKey.
Parameters: out_point – The point for this MarkerKey. Returns: true if a point was set, false otherwise.
-
~MarkerKey()
-
void
