#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::SphereKey |
|
static const HPS::Type | staticType = HPS::Type::GeometryKey |
|
static const HPS::Type | staticType = HPS::Type::Key |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The SphereKey class is a smart pointer to a database object. It is a handle to a sphere inserted via SegmentKey::InsertSphere.
◆ 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_key | The 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
-
◆ 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_that | An rvalue reference to a SphereKey to take the impl from. |
◆ 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_kit | The 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]
◆ operator=() [2/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this SphereKey thereby avoiding a copy.
- Parameters
-
in_that | An 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_kit | The kit from which to get the settings to replace on this SphereKey. |
◆ SetBasis()
Sets the basis for the SphereKey.
- Parameters
-
in_vertical | The vector to use as the vertical axis for the SphereKey. |
in_horizontal | The vector to use as the horizontal axis for the SphereKey. |
- Returns
- A reference to this SphereKey.
◆ SetCenter()
◆ SetRadius()
SphereKey& HPS::SphereKey::SetRadius |
( |
float |
in_radius | ) |
|
◆ Show()
void HPS::SphereKey::Show |
( |
SphereKit & |
out_kit | ) |
const |
Copy the contents of this SphereKey into the specified kit.
- Parameters
-
out_kit | The 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_vertical | The vector to use as the vertical axis for the SphereKey. |
out_horizontal | The 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_center | The 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
-
- Returns
- true if a radius was set, false otherwise.
The documentation for this class was generated from the following file: