REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
void | Consume (PolygonKit &in_kit) |
PolygonKit & | EditPointsByDeletion (size_t in_offset, size_t in_count) |
PolygonKit & | EditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[]) |
PolygonKit & | EditPointsByInsertion (size_t in_offset, PointArray const &in_points) |
PolygonKit & | EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[]) |
PolygonKit & | EditPointsByReplacement (size_t in_offset, PointArray const &in_points) |
bool | Empty () const |
bool | Equals (PolygonKit const &in_kit) const |
size_t | GetPointCount () const |
Type | ObjectType () const |
bool | operator!= (PolygonKit const &in_kit) const |
PolygonKit & | operator= (PolygonKit &&in_that) |
PolygonKit & | operator= (PolygonKit const &in_kit) |
bool | operator== (PolygonKit const &in_kit) const |
PolygonKit () | |
PolygonKit (PolygonKit const &in_kit) | |
PolygonKit (PolygonKit &&in_that) | |
void | Set (PolygonKit const &in_kit) |
PolygonKit & | SetPoints (PointArray const &in_points) |
PolygonKit & | SetPoints (size_t in_count, Point const in_points[]) |
PolygonKit & | SetPriority (int in_priority) |
PolygonKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
PolygonKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
PolygonKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
void | Show (PolygonKit &out_kit) const |
bool | ShowPoints (PointArray &out_points) const |
bool | ShowPriority (int &out_priority) 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 |
PolygonKit & | UnsetAllUserData () |
PolygonKit & | UnsetEverything () |
PolygonKit & | UnsetPoints () |
PolygonKit & | UnsetPriority () |
PolygonKit & | UnsetUserData (intptr_t in_index) |
PolygonKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
PolygonKit & | UnsetUserData (IntPtrTArray const &in_indices) |
![]() | |
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 PolygonKit class is a user space object. It is a kit analog to a PolygonKey.
PolygonKit::PolygonKit | ( | ) |
The default constructor creates an empty PolygonKit object.
PolygonKit::PolygonKit | ( | PolygonKit const & | in_kit | ) |
The copy constructor creates a new PolygonKit object that contains the same settings as the source PolygonKit.
in_kit | The source PolygonKit to copy. |
PolygonKit::PolygonKit | ( | PolygonKit && | in_that | ) |
The move constructor creates a PolygonKit by transferring the underlying impl of the rvalue reference to this PolygonKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to a PolygonKit to take the impl from. |
void PolygonKit::Consume | ( | PolygonKit & | in_kit | ) |
Copies the source PolygonKit into this LineKit and resets the source kit.
in_kit | The source PolygonKit to consume. |
PolygonKit& PolygonKit::EditPointsByDeletion | ( | size_t | in_offset, |
size_t | in_count | ||
) |
Remove the specified number of points from this PolygonKit at the specified offset.
in_offset | The offset into the points for PolygonKit at which to remove points. |
in_count | The number of points to remove. |
PolygonKit& PolygonKit::EditPointsByInsertion | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
Add points to this PolygonKit at the specified offset.
in_offset | The offset into the points for PolygonKit at which to add points. |
in_count | Size of the following array. |
in_points | The points to add to this PolygonKit. |
PolygonKit& PolygonKit::EditPointsByInsertion | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
Add points to this PolygonKit at the specified offset.
in_offset | The offset into the points for PolygonKit at which to add points. |
in_points | The points to add to this PolygonKit. |
PolygonKit& PolygonKit::EditPointsByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
Replace the specified number of points for this PolygonKit at the specified offset.
in_offset | The offset into the points for PolygonKit at which to start replacing points. |
in_count | Size of the following array. |
in_points | The points to use to replace those on this PolygonKit. |
PolygonKit& PolygonKit::EditPointsByReplacement | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
Replace the specified number of points for this PolygonKit at the specified offset.
in_offset | The offset into the points for PolygonKit at which to start replacing points. |
in_points | The points to use to replace those on this PolygonKit. |
|
virtual |
Indicates whether this PolygonKit has any values set on it.
Reimplemented from Object.
bool PolygonKit::Equals | ( | PolygonKit const & | in_kit | ) | const |
Check if the source PolygonKit is equivalent to this PolygonKit.
in_kit | The source PolygonKit to compare to this PolygonKit. |
size_t PolygonKit::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 Object.
bool PolygonKit::operator!= | ( | PolygonKit const & | in_kit | ) | const |
Check if the source PolygonKit is not equivalent to this PolygonKit.
in_kit | The source PolygonKit to compare to this PolygonKit. |
PolygonKit& PolygonKit::operator= | ( | PolygonKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this PolygonKit thereby avoiding a copy.
in_that | An rvalue reference to a PolygonKit to take the impl from. |
PolygonKit& PolygonKit::operator= | ( | PolygonKit const & | in_kit | ) |
Copies the source PolygonKit into this PolygonKit.
in_kit | The source PolygonKit to copy. |
bool PolygonKit::operator== | ( | PolygonKit const & | in_kit | ) | const |
Check if the source PolygonKit is equivalent to this PolygonKit.
in_kit | The source PolygonKit to compare to this PolygonKit. |
void PolygonKit::Set | ( | PolygonKit const & | in_kit | ) |
Copies the source PolygonKit into this PolygonKit.
in_kit | The source PolygonKit to copy. |
PolygonKit& PolygonKit::SetPoints | ( | PointArray const & | in_points | ) |
Sets the points for this PolygonKit.
in_points | The points for this PolygonKit. |
PolygonKit& PolygonKit::SetPoints | ( | size_t | in_count, |
Point const | in_points[] | ||
) |
Sets the points for this PolygonKit.
in_count | Size of the following array. |
in_points | The points for this PolygonKit. |
PolygonKit& PolygonKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the PolygonKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
PolygonKit& PolygonKit::SetUserData | ( | intptr_t | in_index, |
size_t | in_bytes, | ||
byte const | in_data[] | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_bytes | The number of bytes of user data to set. |
in_data | The bytes of user data to set. |
PolygonKit& PolygonKit::SetUserData | ( | intptr_t | in_index, |
ByteArray const & | in_data | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
PolygonKit& PolygonKit::SetUserData | ( | IntPtrTArray const & | in_indices, |
ByteArrayArray const & | in_data | ||
) |
Sets user data on this kit.
out_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
void PolygonKit::Show | ( | PolygonKit & | out_kit | ) | const |
Copies this PolygonKit into the given PolygonKit.
out_kit | The PolygonKit to populate with the contents of this PolygonKit. |
bool PolygonKit::ShowPoints | ( | PointArray & | out_points | ) | const |
Shows the points for this PolygonKit.
out_points | The points for this PolygonKit. |
bool PolygonKit::ShowPriority | ( | int & | out_priority | ) | const |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool PolygonKit::ShowUserData | ( | intptr_t | in_index, |
ByteArray & | out_data | ||
) | const |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
bool PolygonKit::ShowUserData | ( | IntPtrTArray & | out_indices, |
ByteArrayArray & | out_data | ||
) | const |
Shows all user data for this kit.
out_indices | An array of all user data indices set on this kit. |
in_data | An array of all user data set on this kit. |
size_t PolygonKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
bool PolygonKit::ShowUserDataIndices | ( | IntPtrTArray & | out_indices | ) | const |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
PolygonKit& PolygonKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
PolygonKit& PolygonKit::UnsetEverything | ( | ) |
Removes all settings from this PolygonKit.
PolygonKit& PolygonKit::UnsetPoints | ( | ) |
Removes the points for this PolygonKit.
PolygonKit& PolygonKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
PolygonKit& PolygonKit::UnsetUserData | ( | intptr_t | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
PolygonKit& PolygonKit::UnsetUserData | ( | size_t | in_count, |
intptr_t const | in_indices[] | ||
) |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |
PolygonKit& PolygonKit::UnsetUserData | ( | IntPtrTArray const & | in_indices | ) |
Removes the user data at the given indices from this kit.
in_indices | The indices of the user data to remove. |