#include <hps.h>

Inheritance diagram for HPS::MarkerKey:
HPS::GeometryKey HPS::Key HPS::Object

Public Member Functions

void Consume (MarkerKit &in_kit)
 
 MarkerKey ()
 
 MarkerKey (Key const &in_that)
 
 MarkerKey (MarkerKey const &in_that)
 
 MarkerKey (MarkerKey &&in_that)
 
HPS::Type ObjectType () const
 
MarkerKeyoperator= (MarkerKey const &in_that)
 
MarkerKeyoperator= (MarkerKey &&in_that)
 
void Set (MarkerKit const &in_kit)
 
MarkerKeySetPoint (Point const &in_point)
 
void Show (MarkerKit &out_kit) const
 
bool ShowPoint (Point &out_point) const
 
- Public Member Functions inherited from HPS::GeometryKey
 GeometryKey ()
 
 GeometryKey (Key const &in_that)
 
 GeometryKey (GeometryKey const &in_that)
 
 GeometryKey (GeometryKey &&in_that)
 
GeometryKeyoperator= (GeometryKey const &in_that)
 
GeometryKeyoperator= (GeometryKey &&in_that)
 
GeometryKeySetPriority (int in_priority)
 
GeometryKeySetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[])
 
GeometryKeySetUserData (intptr_t in_index, ByteArray const &in_data)
 
GeometryKeySetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data)
 
bool ShowBounding (BoundingKit &out_kit) const
 
bool ShowPriority (int &out_priority) const
 
size_t ShowReferrers (SegmentKeyArray &out_segments) const
 
size_t ShowReferrers (ReferenceKeyArray &out_references) const
 
bool ShowUserData (intptr_t in_index, ByteArray &out_data) const
 
bool ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const
 
size_t ShowUserDataCount () const
 
bool ShowUserDataIndices (IntPtrTArray &out_indices) const
 
GeometryKeyUnsetAllUserData ()
 
GeometryKeyUnsetPriority ()
 
GeometryKeyUnsetUserData (intptr_t in_index)
 
GeometryKeyUnsetUserData (size_t in_count, intptr_t const in_indices[])
 
GeometryKeyUnsetUserData (IntPtrTArray const &in_indices)
 
- Public Member Functions inherited from HPS::Key
virtual void Assign (Key const &in_that)
 
Key CopyTo (SegmentKey const &in_destination) const
 
void Delete ()
 
bool Equals (Key const &in_that) const
 
size_t GetHash () const
 
bool HasOwner () const
 
 Key ()
 
 Key (Key const &in_that)
 
 Key (Control const &in_control)
 
 Key (Key &&in_that)
 
void MoveTo (SegmentKey const &in_new_owner)
 
bool operator!= (Key const &in_that) const
 
Keyoperator= (Key &&in_that)
 
Keyoperator= (Key const &in_that)
 
bool operator== (Key const &in_that) const
 
SegmentKey Owner () const
 
SegmentKey Up () const
 
virtual ~Key ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::MarkerKey
 
- Static Public Attributes inherited from HPS::GeometryKey
static const HPS::Type staticType = HPS::Type::GeometryKey
 
- Static Public Attributes inherited from HPS::Key
static const HPS::Type staticType = HPS::Type::Key
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The MarkerKey class is a smart pointer to a database object. It is a handle to a marker inserted via SegmentKey::InsertMarker.

Constructor & Destructor Documentation

◆ MarkerKey() [1/4]

HPS::MarkerKey::MarkerKey ( )

The default constructor creates an uninitialized MarkerKey object. The Type() function will return Type::None.

◆ MarkerKey() [2/4]

HPS::MarkerKey::MarkerKey ( Key const &  in_that)
explicit

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_thatThe source Key to copy.

◆ MarkerKey() [3/4]

HPS::MarkerKey::MarkerKey ( MarkerKey const &  in_that)

The copy constructor creates a MarkerKey object that shares the underlying smart-pointer of the source MarkerKey.

Parameters
in_thatThe source MarkerKey to copy.

◆ MarkerKey() [4/4]

HPS::MarkerKey::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_thatAn rvalue reference to a MarkerKey to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::MarkerKey::Consume ( MarkerKit in_kit)

Completely replaces all settings on this MarkerKey with those set on the specified kit and resets the kit.

Parameters
in_kitThe kit from which to get the settings to replace on this MarkerKey.

◆ ObjectType()

HPS::Type HPS::MarkerKey::ObjectType ( ) const
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.

◆ operator=() [1/2]

MarkerKey& HPS::MarkerKey::operator= ( MarkerKey const &  in_that)

Associate this MarkerKey with the same underlying impl as the source MarkerKey.

Parameters
in_thatThe source MarkerKey for the assignment.
Returns
A reference to this MarkerKey.

◆ operator=() [2/2]

MarkerKey& HPS::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_thatAn rvalue reference to a MarkerKey to take the impl from.
Returns
A reference to this MarkerKey.

◆ Set()

void HPS::MarkerKey::Set ( MarkerKit const &  in_kit)

Replace those settings on this MarkerKey with those set on the specified kit.

Parameters
in_kitThe kit from which to get the settings to replace on this MarkerKey.

◆ SetPoint()

MarkerKey& HPS::MarkerKey::SetPoint ( Point const &  in_point)

Sets the point for this MarkerKey.

Parameters
in_pointThe point for this MarkerKey.
Returns
A reference to this MarkerKey.

◆ Show()

void HPS::MarkerKey::Show ( MarkerKit out_kit) const

Copy the contents of this MarkerKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this MarkerKey.

◆ ShowPoint()

bool HPS::MarkerKey::ShowPoint ( Point out_point) const

Shows the point for this MarkerKey.

Parameters
out_pointThe point for this MarkerKey.
Returns
true if a point was set, false otherwise.

The documentation for this class was generated from the following file: