HPS::InfiniteLineKey Class Reference

#include <hps.h>

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

Public Member Functions

void Consume (InfiniteLineKit &in_kit)
 
 InfiniteLineKey ()
 
 InfiniteLineKey (Key const &in_that)
 
 InfiniteLineKey (InfiniteLineKey const &in_that)
 
 InfiniteLineKey (InfiniteLineKey &&in_that)
 
HPS::Type ObjectType () const
 
InfiniteLineKeyoperator= (InfiniteLineKey const &in_that)
 
InfiniteLineKeyoperator= (InfiniteLineKey &&in_that)
 
void Set (InfiniteLineKit const &in_kit)
 
InfiniteLineKeySetFirst (Point const &in_first)
 
InfiniteLineKeySetSecond (Point const &in_second)
 
InfiniteLineKeySetType (InfiniteLine::Type in_type)
 
void Show (InfiniteLineKit &out_kit) const
 
bool ShowFirst (Point &out_first) const
 
bool ShowSecond (Point &out_second) const
 
bool ShowType (InfiniteLine::Type &out_type) 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::InfiniteLineKey
 
- 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 InfiniteLineKey class is a smart pointer to a database object. It is a handle to an infinite line or ray inserted via SegmentKey::InsertInfiniteLine.

Constructor & Destructor Documentation

◆ InfiniteLineKey() [1/4]

HPS::InfiniteLineKey::InfiniteLineKey ( )

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

◆ InfiniteLineKey() [2/4]

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

This constructor creates an InfiniteLineKey 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 an InfiniteLine key. Otherwise the copy will fail and the resulting InfiniteLineKey will be invalid.

Parameters
in_thatThe source Key to copy.

◆ InfiniteLineKey() [3/4]

HPS::InfiniteLineKey::InfiniteLineKey ( InfiniteLineKey const &  in_that)

The copy constructor creates an InfiniteLineKey object that shares the underlying smart-pointer of the source InfiniteLineKey.

Parameters
in_thatThe source InfiniteLineKey to copy.

◆ InfiniteLineKey() [4/4]

HPS::InfiniteLineKey::InfiniteLineKey ( InfiniteLineKey &&  in_that)

The move constructor creates an InfiniteLineKey by transferring the underlying impl of the rvalue reference to this InfiniteLineKey thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a InfiniteLineKey to take the impl from.

Member Function Documentation

◆ Consume()

void HPS::InfiniteLineKey::Consume ( InfiniteLineKit in_kit)

Completely replaces all settings on this InfiniteLineKey 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 InfiniteLineKey.

◆ ObjectType()

HPS::Type HPS::InfiniteLineKey::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]

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

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

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

◆ operator=() [2/2]

InfiniteLineKey& HPS::InfiniteLineKey::operator= ( InfiniteLineKey &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this InfiniteLineKey thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an InfiniteLineKey to take the impl from.
Returns
A reference to this InfiniteLineKey.

◆ Set()

void HPS::InfiniteLineKey::Set ( InfiniteLineKit const &  in_kit)

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

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

◆ SetFirst()

InfiniteLineKey& HPS::InfiniteLineKey::SetFirst ( Point const &  in_first)

Sets the first point for this InfiniteLineKey.

Parameters
in_firstThe first point for this InfiniteLineKey. If the type is InfiniteLine::Type::Ray, this will be the point at which the ray starts.
Returns
A reference to this InfiniteLineKey.

◆ SetSecond()

InfiniteLineKey& HPS::InfiniteLineKey::SetSecond ( Point const &  in_second)

Sets the second point for this InfiniteLineKey.

Parameters
in_secondThe second point for this InfiniteLineKey. If the type is InfiniteLine::Type::Ray, this will be the point through which the ray passes.
Returns
A reference to this InfiniteLineKey.

◆ SetType()

InfiniteLineKey& HPS::InfiniteLineKey::SetType ( InfiniteLine::Type  in_type)

Sets the type of this InfiniteLineKey.

Parameters
in_typeThe type of this InfiniteLineKey.
Returns
A reference to this InfiniteLineKey.

◆ Show()

void HPS::InfiniteLineKey::Show ( InfiniteLineKit out_kit) const

Copy the contents of this InfiniteLineKey into the specified kit.

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

◆ ShowFirst()

bool HPS::InfiniteLineKey::ShowFirst ( Point out_first) const

Shows the first point for this InfiniteLineKey.

Parameters
out_firstThe first point for this InfiniteLineKey.
Returns
true if a first point was set, false otherwise.

◆ ShowSecond()

bool HPS::InfiniteLineKey::ShowSecond ( Point out_second) const

Shows the second point for this InfiniteLineKey.

Parameters
out_secondThe second point for this InfiniteLineKey.
Returns
true if a second point was set, false otherwise.

◆ ShowType()

bool HPS::InfiniteLineKey::ShowType ( InfiniteLine::Type out_type) const

Shows the type of this InfiniteLineKey.

Parameters
out_typeThe type of this InfiniteLineKey.
Returns
true if a type was set, false otherwise.

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