REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
CircularWedgeKey () | |
CircularWedgeKey (Key const &in_that) | |
CircularWedgeKey (CircularWedgeKey const &in_that) | |
CircularWedgeKey (CircularWedgeKey &&in_that) | |
void | Consume (CircularWedgeKit &in_kit) |
Type | ObjectType () const |
CircularWedgeKey & | operator= (CircularWedgeKey const &in_that) |
CircularWedgeKey & | operator= (CircularWedgeKey &&in_that) |
void | Set (CircularWedgeKit const &in_kit) |
CircularWedgeKey & | SetEnd (Point const &in_end) |
CircularWedgeKey & | SetMiddle (Point const &in_middle) |
CircularWedgeKey & | SetStart (Point const &in_start) |
void | Show (CircularWedgeKit &out_kit) const |
bool | ShowEnd (Point &out_end) const |
bool | ShowMiddle (Point &out_middle) const |
bool | ShowStart (Point &out_start) 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 | ShowBoundings (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 (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The CircularWedgeKey class is a smart pointer to a database object. It is a handle to a circular wedge inserted via SegmentKey::InsertCircularWedge. A circular wedge has face geometry contained within the boundary edges of the circular wedge. The visualization of the wedge will be determined by attribute settings affecting faces and edges.
CircularWedgeKey::CircularWedgeKey | ( | ) |
The default constructor creates an uninitialized CircularWedgeKey object. The Type() function will return Type::None.
|
explicit |
This constructor creates a CircularWedgeKey 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 CircularWedge key. Otherwise the copy will fail and the resulting CircularWedgeKey will be invalid.
in_key | The source Key to copy. |
CircularWedgeKey::CircularWedgeKey | ( | CircularWedgeKey const & | in_that | ) |
The copy constructor creates a CircularWedgeKey object that shares the underlying smart-pointer of the source CircularWedgeKey.
in_that | The source CircularWedgeKey to copy. |
CircularWedgeKey::CircularWedgeKey | ( | CircularWedgeKey && | in_that | ) |
The move constructor creates a CircularWedgeKey by transferring the underlying impl of the rvalue reference to this CircularWedgeKey thereby avoiding a copy and allocation.
in_that | An rvalue reference to a CircularWedgeKey to take the impl from. |
void CircularWedgeKey::Consume | ( | CircularWedgeKit & | in_kit | ) |
Completely replaces all settings on this CircularWedgeKey with those set on the specified kit and resets the kit.
in_kit | The kit from which to get the settings to replace on this CircularWedgeKey. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from GeometryKey.
CircularWedgeKey& CircularWedgeKey::operator= | ( | CircularWedgeKey const & | in_that | ) |
Associate this CircularWedgeKey with the same underlying impl as the source CircularWedgeKey.
in_that | The source CircularWedgeKey for the assignment. |
CircularWedgeKey& CircularWedgeKey::operator= | ( | CircularWedgeKey && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CircularWedgeKey thereby avoiding a copy.
in_that | An rvalue reference to a CircularWedgeKey to take the impl from. |
void CircularWedgeKey::Set | ( | CircularWedgeKit const & | in_kit | ) |
Replace those settings on this CircularWedgeKey with those set on the specified kit.
in_kit | The kit from which to get the settings to replace on this CircularWedgeKey. |
CircularWedgeKey& CircularWedgeKey::SetEnd | ( | Point const & | in_end | ) |
Sets the end point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge ends.
in_end | The end point for this CircularWedgeKey. |
CircularWedgeKey& CircularWedgeKey::SetMiddle | ( | Point const & | in_middle | ) |
Sets the middle point for this CircularWedgeKey. This is a point on the circumference of the circle between the start and end points for the circular wedge.
in_middle | The middle point for this CircularWedgeKey. |
CircularWedgeKey& CircularWedgeKey::SetStart | ( | Point const & | in_start | ) |
Sets the start point for this CircularWedgeKey. This is the point on the circumference of the circle at which the circular wedge starts.
in_start | The start point for this CircularWedgeKey. |
void CircularWedgeKey::Show | ( | CircularWedgeKit & | out_kit | ) | const |
Copy the contents of this CircularWedgeKey into the specified kit.
out_kit | The kit to populate with the contents of this CircularWedgeKey. |
bool CircularWedgeKey::ShowEnd | ( | Point & | out_end | ) | const |
Shows the end point for this CircularWedgeKey.
out_end | The end point for this CircularWedgeKey. |
bool CircularWedgeKey::ShowMiddle | ( | Point & | out_middle | ) | const |
Shows the middle point for this CircularWedgeKey.
out_middle | The middle point for this CircularWedgeKey. |
bool CircularWedgeKey::ShowStart | ( | Point & | out_start | ) | const |
Shows the start point for this CircularWedgeKey.
out_start | The start point for this CircularWedgeKey. |