#include <hps.h>

Public Member Functions | |
void | Consume (EllipseKit &in_kit) |
EllipseKey () | |
EllipseKey (Key const &in_that) | |
EllipseKey (EllipseKey const &in_that) | |
EllipseKey (EllipseKey &&in_that) | |
HPS::Type | ObjectType () const |
EllipseKey & | operator= (EllipseKey const &other) |
EllipseKey & | operator= (EllipseKey &&in_that) |
void | Set (EllipseKit const &in_kit) |
EllipseKey & | SetCenter (Point const &in_center) |
EllipseKey & | SetMajor (Point const &in_major) |
EllipseKey & | SetMinor (Point const &in_minor) |
void | Show (EllipseKit &out_kit) const |
bool | ShowCenter (Point &out_center) const |
bool | ShowMajor (Point &out_major) const |
bool | ShowMinor (Point &out_minor) 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 EllipseKey class is a smart pointer to a database object. It is a handle to an ellipse inserted via SegmentKey::InsertEllipse.
Constructor & Destructor Documentation
HPS::EllipseKey::EllipseKey | ( | ) |
The default constructor creates an uninitialized EllipseKey object. The Type() function will return Type::None.
|
explicit |
This constructor creates an EllipseKey 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 an Ellipse key. Otherwise the copy will fail and the resulting EllipseKey will be invalid.
- Parameters
-
in_key The source Key to copy.
HPS::EllipseKey::EllipseKey | ( | EllipseKey const & | in_that | ) |
The copy constructor creates an EllipseKey object that shares the underlying smart-pointer of the source EllipseKey.
- Parameters
-
in_that The source EllipseKey to copy.
HPS::EllipseKey::EllipseKey | ( | EllipseKey && | in_that | ) |
The move constructor creates an EllipseKey by transferring the underlying impl of the rvalue reference to this EllipseKey thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an EllipseKey to take the impl from.
Member Function Documentation
void HPS::EllipseKey::Consume | ( | EllipseKit & | in_kit | ) |
Completely replaces all settings on this EllipseKit 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 EllipseKit.
|
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.
EllipseKey& HPS::EllipseKey::operator= | ( | EllipseKey const & | other | ) |
Associate this EllipseKey with the same underlying impl as the source EllipseKey.
- Parameters
-
in_that The source EllipseKey for the assignment.
- Returns
- A reference to this EllipseKey.
EllipseKey& HPS::EllipseKey::operator= | ( | EllipseKey && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this EllipseKey thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an EllipseKey to take the impl from.
- Returns
- A reference to this EllipseKey.
void HPS::EllipseKey::Set | ( | EllipseKit const & | in_kit | ) |
Replace those settings on this EllipseKey with those set on the specified kit.
- Parameters
-
in_kit The kit from which to get the settings to replace on this EllipseKey.
EllipseKey& HPS::EllipseKey::SetCenter | ( | Point const & | in_center | ) |
Sets the center point for the ellipse.
- Parameters
-
in_center The center point for the ellipse.
- Returns
- A reference to this EllipseKey.
EllipseKey& HPS::EllipseKey::SetMajor | ( | Point const & | in_major | ) |
Sets the intersection point of the major axis and the ellipse.
- Parameters
-
in_major The intersection point of the major axis and the ellipse.
- Returns
- A reference to this EllipseKey.
EllipseKey& HPS::EllipseKey::SetMinor | ( | Point const & | in_minor | ) |
Sets the intersection point of the minor axis and the ellipse.
- Parameters
-
in_minor The intersection point of the minor axis and the ellipse.
- Returns
- A reference to this EllipseKey.
void HPS::EllipseKey::Show | ( | EllipseKit & | out_kit | ) | const |
Copy the contents of this EllipseKey into the specified kit.
- Parameters
-
out_kit The kit to populate with the contents of this EllipseKey.
bool HPS::EllipseKey::ShowCenter | ( | Point & | out_center | ) | const |
Shows the center point for the ellipse.
- Parameters
-
out_center The center point for the ellipse.
- Returns
- true if a center was set, false otherwise.
bool HPS::EllipseKey::ShowMajor | ( | Point & | out_major | ) | const |
Shows the intersection point of the major axis and the ellipse.
- Parameters
-
out_major The intersection point of the major axis and the ellipse.
- Returns
- true if an intersection point with the major axis was set, false otherwise.
bool HPS::EllipseKey::ShowMinor | ( | Point & | out_minor | ) | const |
Shows the intersection point of the minor axis and the ellipse.
- Parameters
-
out_minor The intersection point of the minor axis and the ellipse.
- Returns
- true if an intersection point with the minor axis was set, false otherwise.
The documentation for this class was generated from the following file:
- include/hps.h