#include <hps.h>

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

Public Member Functions

void Consume (SphereKit &in_kit)
 
HPS::Type ObjectType () const
 
SphereKeyoperator= (SphereKey const &in_that)
 
SphereKeyoperator= (SphereKey &&in_that)
 
void Set (SphereKit const &in_kit)
 
SphereKeySetBasis (Vector const &in_vertical, Vector const &in_horizontal)
 
SphereKeySetCenter (Point const &in_center)
 
SphereKeySetRadius (float in_radius)
 
void Show (SphereKit &out_kit) const
 
bool ShowBasis (Vector &out_vertical, Vector &out_horizontal) const
 
bool ShowCenter (Point &out_center) const
 
bool ShowRadius (float &out_radius) const
 
 SphereKey ()
 
 SphereKey (Key const &in_that)
 
 SphereKey (SphereKey const &in_that)
 
 SphereKey (SphereKey &&in_that)
 
- 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::SphereKey
 
- 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 SphereKey class is a smart pointer to a database object. It is a handle to a sphere inserted via SegmentKey::InsertSphere.

Constructor & Destructor Documentation

◆ SphereKey() [1/4]

HPS::SphereKey::SphereKey ( )

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

◆ SphereKey() [2/4]

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

This constructor creates a SphereKey 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 Sphere key. Otherwise the copy will fail and the resulting SphereKey will be invalid.

Parameters
in_keyThe source Key to copy.

◆ SphereKey() [3/4]

HPS::SphereKey::SphereKey ( SphereKey const &  in_that)

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

Parameters
in_thatThe source SphereKey to copy.

◆ SphereKey() [4/4]

HPS::SphereKey::SphereKey ( SphereKey &&  in_that)

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

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

Member Function Documentation

◆ Consume()

void HPS::SphereKey::Consume ( SphereKit in_kit)

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

◆ ObjectType()

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

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

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

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

◆ operator=() [2/2]

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

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

Parameters
in_thatAn rvalue reference to a SphereKey to take the impl from.
Returns
A reference to this SphereKey.

◆ Set()

void HPS::SphereKey::Set ( SphereKit const &  in_kit)

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

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

◆ SetBasis()

SphereKey& HPS::SphereKey::SetBasis ( Vector const &  in_vertical,
Vector const &  in_horizontal 
)

Sets the basis for the SphereKey.

Parameters
in_verticalThe vector to use as the vertical axis for the SphereKey.
in_horizontalThe vector to use as the horizontal axis for the SphereKey.
Returns
A reference to this SphereKey.

◆ SetCenter()

SphereKey& HPS::SphereKey::SetCenter ( Point const &  in_center)

Sets the center point for the SphereKey.

Parameters
in_centerThe center point for the SphereKey.
Returns
A reference to this SphereKey.

◆ SetRadius()

SphereKey& HPS::SphereKey::SetRadius ( float  in_radius)

Sets the radius for the SphereKey.

Parameters
in_radiusThe radius for the SphereKey.
Returns
A reference to this SphereKey.

◆ Show()

void HPS::SphereKey::Show ( SphereKit out_kit) const

Copy the contents of this SphereKey into the specified kit.

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

◆ ShowBasis()

bool HPS::SphereKey::ShowBasis ( Vector out_vertical,
Vector out_horizontal 
) const

Shows the basis for the SphereKey.

Parameters
out_verticalThe vector to use as the vertical axis for the SphereKey.
out_horizontalThe vector to use as the horizontal axis for the SphereKey.
Returns
true if a basis was set, false otherwise.

◆ ShowCenter()

bool HPS::SphereKey::ShowCenter ( Point out_center) const

Shows the center point for this SphereKey.

Parameters
out_centerThe center point for the SphereKey.
Returns
true if a center point was set, false otherwise.

◆ ShowRadius()

bool HPS::SphereKey::ShowRadius ( float &  out_radius) const

Shows the radius for the SphereKey.

Parameters
out_radiusThe radius for the SphereKey.
Returns
true if a radius was set, false otherwise.

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