API Search || Global Search

#include <hps.h>

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

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
 
CircleKeyoperator= (CircleKey const &in_that)
 
CircleKeyoperator= (CircleKey &&in_that)
 
void Set (CircleKit const &in_kit)
 
CircleKeySetCenter (Point const &in_center)
 
CircleKeySetNormal (Vector const &in_normal)
 
CircleKeySetRadius (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
 
- 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::CircleKey
 
- 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 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 ( )

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

HPS::CircleKey::CircleKey ( Key const &  in_that)
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_keyThe source Key to copy.
HPS::CircleKey::CircleKey ( CircleKey const &  in_that)

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

Parameters
in_thatThe source CircleKey to copy.
HPS::CircleKey::CircleKey ( CircleKey &&  in_that)

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

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

Member Function Documentation

void HPS::CircleKey::Consume ( CircleKit in_kit)

Completely replaces all settings on this CircleKey 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 CircleKey.
CircleKey& HPS::CircleKey::operator= ( CircleKey const &  in_that)

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

Parameters
in_thatThe source CircleKey for the assignment.
Returns
A reference to this CircleKey.
CircleKey& HPS::CircleKey::operator= ( CircleKey &&  in_that)

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

Parameters
in_thatAn rvalue reference to a CircleKey to take the impl from.
Returns
A reference to this CircleKey.
void HPS::CircleKey::Set ( CircleKit const &  in_kit)

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

Parameters
in_kitThe kit from which to get the settings to replace on this CircleKey.
CircleKey& HPS::CircleKey::SetCenter ( Point const &  in_center)

Sets the center point for this CircleKey.

Parameters
in_centerThe center point for this CircleKey.
Returns
A reference to this CircleKey.
CircleKey& HPS::CircleKey::SetNormal ( Vector const &  in_normal)

Sets the normal for this CircleKey. This is the normal for the plane in which the circle lies.

Parameters
in_normalThe normal for this CircleKey.
Returns
A reference to this CircleKey.
CircleKey& HPS::CircleKey::SetRadius ( float  in_radius)

Sets the radius for this CircleKey.

Parameters
in_radiusThe radius for this CircleKey.
Returns
A reference to this CircleKey.
void HPS::CircleKey::Show ( CircleKit out_kit) const

Copy the contents of this CircleKey into the specified kit.

Parameters
out_kitThe kit to populate with the contents of this CircleKey.
bool HPS::CircleKey::ShowCenter ( Point out_center) const

Shows the center point for this CircleKey.

Parameters
out_centerThe center point for this CircleKey.
Returns
true if a center point was set, false otherwise.
bool HPS::CircleKey::ShowNormal ( Vector out_normal) const

Shows the normal for this CircleKey.

Parameters
out_normalThe normal for this CircleKey.
Returns
true if a normal was set, false otherwise.
bool HPS::CircleKey::ShowRadius ( float &  out_radius) const

Shows the radius for this CircleKey.

Parameters
out_radiusThe radius for this CircleKey.
Returns
true if a radius was set, false otherwise.

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