#include <hps.h>
Public Member Functions | |
PolygonKey () | |
PolygonKey (Key const &in_that) | |
PolygonKey (PolygonKey const &in_that) | |
PolygonKey & | operator= (PolygonKey const &in_that) |
PolygonKey (PolygonKey &&in_that) | |
PolygonKey & | operator= (PolygonKey &&in_that) |
HPS::Type | ObjectType () const |
void | Consume (PolygonKit &in_kit) |
void | Set (PolygonKit const &in_kit) |
void | Show (PolygonKit &out_kit) const |
size_t | GetPointCount () const |
PolygonKey & | SetPoints (PointArray const &in_points) |
PolygonKey & | SetPoints (size_t in_count, Point const in_points[]) |
bool | ShowPoints (PointArray &out_points) const |
bool | ShowPointsByRange (size_t in_start_index, size_t in_count, PointArray &out_points) const |
bool | ShowPointsByList (SizeTArray const &in_indices, PointArray &out_points) const |
bool | ShowPointsByList (size_t in_count, size_t const in_indices[], PointArray &out_points) const |
PolygonKey & | EditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[]) |
PolygonKey & | EditPointsByInsertion (size_t in_offset, PointArray const &in_points) |
PolygonKey & | EditPointsByDeletion (size_t in_offset, size_t in_count) |
PolygonKey & | EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[]) |
PolygonKey & | EditPointsByReplacement (size_t in_offset, PointArray const &in_points) |
![]() | |
GeometryKey () | |
GeometryKey (Key const &in_that) | |
GeometryKey (GeometryKey const &in_that) | |
GeometryKey & | operator= (GeometryKey const &in_that) |
GeometryKey (GeometryKey &&in_that) | |
GeometryKey & | operator= (GeometryKey &&in_that) |
size_t | ShowReferrers (SegmentKeyArray &out_segments) const |
size_t | ShowReferrers (ReferenceKeyArray &out_references) const |
GeometryKey & | SetPriority (int in_priority) |
GeometryKey & | UnsetPriority () |
bool | ShowPriority (int &out_priority) const |
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) |
GeometryKey & | UnsetUserData (intptr_t in_index) |
GeometryKey & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
GeometryKey & | UnsetUserData (IntPtrTArray const &in_indices) |
GeometryKey & | UnsetAllUserData () |
size_t | ShowUserDataCount () const |
bool | ShowUserDataIndices (IntPtrTArray &out_indices) const |
bool | ShowUserData (intptr_t in_index, ByteArray &out_data) const |
bool | ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const |
bool | ShowBoundings (BoundingKit &out_kit) const |
![]() | |
Key () | |
Key (Key const &in_that) | |
Key (Control const &in_control) | |
Key (Key &&in_that) | |
Key & | operator= (Key &&in_that) |
virtual | ~Key () |
bool | HasOwner () const |
SegmentKey | Up () const |
SegmentKey | Owner () const |
void | Delete () |
void | MoveTo (SegmentKey const &in_new_owner) |
Key | CopyTo (SegmentKey const &in_destination) const |
Key & | operator= (Key const &in_that) |
virtual void | Assign (Key const &in_that) |
bool | Equals (Key const &in_that) const |
bool | operator!= (Key const &in_that) const |
bool | operator== (Key const &in_that) const |
size_t | GetHash () const |
![]() | |
Object (Object const &that) | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual bool | Empty () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The PolygonKey class is a smart pointer to a database object. It is a handle to a polygon created by SegmentKey::InsertPolygon.
HPS::PolygonKey::PolygonKey | ( | ) |
The default constructor creates an uninitialized PolygonKey object. The Type() function will return Type::None.
|
explicit |
This constructor creates an PolygonKey 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 polygon key. Otherwise the copy will fail and the resulting PolygonKey will be invalid.
in_key | The source Key to copy. |
HPS::PolygonKey::PolygonKey | ( | PolygonKey const & | in_that | ) |
The copy constructor creates a PolygonKey object that shares the underlying smart-pointer of the source PolygonKey.
in_that | The source PolygonKey to copy. |
HPS::PolygonKey::PolygonKey | ( | PolygonKey && | in_that | ) |
The move constructor creates a PolygonKey by transferring the underlying impl of the rvalue reference to this PolygonKey thereby avoiding a copy and allocation.
in_that | An rvalue reference to a PolygonKey to take the impl from. |
void HPS::PolygonKey::Consume | ( | PolygonKit & | in_kit | ) |
Completely replaces all settings on this PolygonKit 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 PolygonKit. |
PolygonKey& HPS::PolygonKey::EditPointsByDeletion | ( | size_t | in_offset, |
size_t | in_count | ||
) |
Remove the specified number of points from this PolygonKey at the specified offset.
in_offset | The offset into the points for PolygonKey at which to remove points. |
in_count | The number of points to remove. |
PolygonKey& HPS::PolygonKey::EditPointsByInsertion | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
Add points to this PolygonKey at the specified offset.
in_offset | The offset into the points for PolygonKey at which to add points. |
in_count | Size of the following array. |
in_points | The points to add to this PolygonKey. |
PolygonKey& HPS::PolygonKey::EditPointsByInsertion | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
Add points to this PolygonKey at the specified offset.
in_offset | The offset into the points for PolygonKey at which to add points. |
in_points | The points to add to this PolygonKey. |
PolygonKey& HPS::PolygonKey::EditPointsByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
Replace the specified number of points for this PolygonKey at the specified offset.
in_offset | The offset into the points for PolygonKey at which to start replacing points. |
in_count | Size of the following array. |
in_points | The points to use to replace those on this PolygonKey. |
PolygonKey& HPS::PolygonKey::EditPointsByReplacement | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
Replace the specified number of points for this PolygonKey at the specified offset.
in_offset | The offset into the points for PolygonKey at which to start replacing points. |
in_points | The points to use to replace those on this PolygonKey. |
size_t HPS::PolygonKey::GetPointCount | ( | ) | const |
Retrieves the number of points in this polygon.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::GeometryKey.
PolygonKey& HPS::PolygonKey::operator= | ( | PolygonKey const & | in_that | ) |
Associate this PolygonKey with the same underlying impl as the source PolygonKey.
in_that | The source PolygonKey for the assignment. |
PolygonKey& HPS::PolygonKey::operator= | ( | PolygonKey && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this PolygonKey thereby avoiding a copy.
in_that | An rvalue reference to a PolygonKey to take the impl from. |
void HPS::PolygonKey::Set | ( | PolygonKit const & | in_kit | ) |
Replace those settings on this PolygonKey with those set on the specified kit.
in_kit | The kit from which to get the settings to replace on this PolygonKey. |
PolygonKey& HPS::PolygonKey::SetPoints | ( | PointArray const & | in_points | ) |
Replace the points on this PolygonKey with the specified points.
in_points | The points to use to replace those on this PolygonKey. |
PolygonKey& HPS::PolygonKey::SetPoints | ( | size_t | in_count, |
Point const | in_points[] | ||
) |
Replace the points on this PolygonKey with the specified points.
in_count | Size of the following array. |
in_points | The points to use to replace those on this PolygonKey. |
void HPS::PolygonKey::Show | ( | PolygonKit & | out_kit | ) | const |
Copy the contents of this PolygonKey into the specified kit.
out_kit | The kit to populate with the contents of this PolygonKey. |
bool HPS::PolygonKey::ShowPoints | ( | PointArray & | out_points | ) | const |
Show the points for this PolygonKey.
out_points | The points for this PolygonKey. |
bool HPS::PolygonKey::ShowPointsByList | ( | SizeTArray const & | in_indices, |
PointArray & | out_points | ||
) | const |
Show a subset of the points for this PolygonKey by list.
in_indices | The list of point indices to show. |
out_points | The requested points for this PolygonKey. |
bool HPS::PolygonKey::ShowPointsByList | ( | size_t | in_count, |
size_t const | in_indices[], | ||
PointArray & | out_points | ||
) | const |
Show a subset of the points for this PolygonKey by list.
in_count | The number of points to show. |
in_indices | The list of point indices to show. |
out_points | The requested points for this PolygonKey. |
bool HPS::PolygonKey::ShowPointsByRange | ( | size_t | in_start_index, |
size_t | in_count, | ||
PointArray & | out_points | ||
) | const |
Show a subset of the points for this PolygonKey by range.
in_start_index | The first point to show. |
in_count | The number of points to show. |
out_points | The requested points for this PolygonKey. |