#include <hps.h>

Public Member Functions | |
CircleKey () | |
CircleKey (Key const &in_that) | |
CircleKey (CircleKey const &in_that) | |
CircleKey (CircleKey &&in_that) | |
void | Consume (CircleKit &in_kit) |
HPS::Type | ObjectType () const |
CircleKey & | operator= (CircleKey const &in_that) |
CircleKey & | operator= (CircleKey &&in_that) |
void | Set (CircleKit const &in_kit) |
CircleKey & | SetCenter (Point const &in_center) |
CircleKey & | SetNormal (Vector const &in_normal) |
CircleKey & | SetRadius (float in_radius) |
void | Show (CircleKit &out_kit) const |
bool | ShowCenter (Point &out_center) const |
bool | ShowNormal (Vector &out_normal) const |
bool | ShowRadius (float &out_radius) const |
![]() | |
GeometryKey () | |
GeometryKey (Key const &in_that) | |
GeometryKey (GeometryKey const &in_that) | |
GeometryKey (GeometryKey &&in_that) | |
GeometryKey & | operator= (GeometryKey const &in_that) |
GeometryKey & | operator= (GeometryKey &&in_that) |
GeometryKey & | SetPriority (int in_priority) |
GeometryKey & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
GeometryKey & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
GeometryKey & | SetUserData (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 |
GeometryKey & | UnsetAllUserData () |
GeometryKey & | UnsetPriority () |
GeometryKey & | UnsetUserData (intptr_t in_index) |
GeometryKey & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
GeometryKey & | UnsetUserData (IntPtrTArray const &in_indices) |
![]() | |
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 |
Key & | operator= (Key &&in_that) |
Key & | operator= (Key const &in_that) |
bool | operator== (Key const &in_that) const |
SegmentKey | Owner () const |
SegmentKey | Up () const |
virtual | ~Key () |
![]() | |
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) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The CircleKey class is a smart pointer to a database object. It is a handle to a circle inserted via SegmentKey::InsertCircle. A circle has face geometry contained within its circumference. The visualization of the circle will be determined by attribute settings affecting faces and edges.
Constructor & Destructor Documentation
HPS::CircleKey::CircleKey | ( | ) |
|
explicit |
This constructor creates a CircleKey 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 Circle key. Otherwise the copy will fail and the resulting CircleKey will be invalid.
- Parameters
-
in_key The source Key to copy.
HPS::CircleKey::CircleKey | ( | CircleKey const & | in_that | ) |
HPS::CircleKey::CircleKey | ( | CircleKey && | in_that | ) |
Member Function Documentation
void HPS::CircleKey::Consume | ( | CircleKit & | in_kit | ) |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::GeometryKey.
void HPS::CircleKey::Set | ( | CircleKit const & | in_kit | ) |
CircleKey& HPS::CircleKey::SetRadius | ( | float | in_radius | ) |
void HPS::CircleKey::Show | ( | CircleKit & | out_kit | ) | const |
bool HPS::CircleKey::ShowCenter | ( | Point & | out_center | ) | const |
bool HPS::CircleKey::ShowNormal | ( | Vector & | out_normal | ) | const |
bool HPS::CircleKey::ShowRadius | ( | float & | out_radius | ) | const |
The documentation for this class was generated from the following file:
- include/hps.h