REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
void | Consume (LineKit &in_kit) |
LineKit & | EditPointsByDeletion (size_t in_offset, size_t in_count) |
LineKit & | EditPointsByInsertion (size_t in_offset, size_t in_count, Point const in_points[]) |
LineKit & | EditPointsByInsertion (size_t in_offset, PointArray const &in_points) |
LineKit & | EditPointsByReplacement (size_t in_offset, size_t in_count, Point const in_points[]) |
LineKit & | EditPointsByReplacement (size_t in_offset, PointArray const &in_points) |
bool | Empty () const |
bool | Equals (LineKit const &in_kit) const |
size_t | GetPointCount () const |
LineKit () | |
LineKit (LineKit const &in_kit) | |
LineKit (LineKit &&in_that) | |
Type | ObjectType () const |
bool | operator!= (LineKit const &in_kit) const |
LineKit & | operator= (LineKit &&in_that) |
LineKit & | operator= (LineKit const &in_kit) |
bool | operator== (LineKit const &in_kit) const |
void | Set (LineKit const &in_kit) |
LineKit & | SetPoints (PointArray const &in_points) |
LineKit & | SetPoints (size_t in_count, Point const in_points[]) |
LineKit & | SetPriority (int in_priority) |
LineKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
LineKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
LineKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
void | Show (LineKit &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 |
LineKit & | UnsetAllUserData () |
LineKit & | UnsetEverything () |
LineKit & | UnsetPoints () |
LineKit & | UnsetPriority () |
LineKit & | UnsetUserData (intptr_t in_index) |
LineKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
LineKit & | 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 () |
LineKit::LineKit | ( | ) |
The default constructor creates an empty LineKit object.
LineKit::LineKit | ( | LineKit const & | in_kit | ) |
LineKit::LineKit | ( | LineKit && | in_that | ) |
void LineKit::Consume | ( | LineKit & | in_kit | ) |
LineKit& LineKit::EditPointsByDeletion | ( | size_t | in_offset, |
size_t | in_count | ||
) |
Removes points from the point list for this LineKit.
in_offset | The offset into the point list for the line at which to start removing points. This value must be such that in_offset<point_count for deletion to succeed. |
in_count | The number of points to delete from the point list for the line. This value must be such that in_offset+in_count<=point_count for the deletion to succeed. |
LineKit& LineKit::EditPointsByInsertion | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
Adds points to the point list for this LineKit.
in_offset | The offset into the point list for the line at which to insert points. This value must be such that in_offset<point_count for insertion to succeed. |
in_count | Size of the following array. |
in_points | The points to insert into the point list at the specified offset. |
LineKit& LineKit::EditPointsByInsertion | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
Adds points to the point list for this LineKit.
in_offset | The offset into the point list for the line at which to insert points. This value must be such that in_offset<point_count for insertion to succeed. |
in_points | The points to insert into the point list at the specified offset. |
LineKit& LineKit::EditPointsByReplacement | ( | size_t | in_offset, |
size_t | in_count, | ||
Point const | in_points[] | ||
) |
Replaces points in the point list for this LineKit.
in_offset | The offset into the point list for the line at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed. |
in_count | Size of the following array. This value must be such that in_offset+in_count<=point_count for the replacement to succeed. |
in_points | The points to use to replace those in the point list at the specified offset. |
LineKit& LineKit::EditPointsByReplacement | ( | size_t | in_offset, |
PointArray const & | in_points | ||
) |
Replaces points in the point list for this LineKit.
in_offset | The offset into the point list for the line at which to start replacing points. This value must be such that in_offset<point_count for replacement to succeed. |
in_points | The points to use to replace those in the point list at the specified offset. This size of the array must be such that in_offset+in_points.size()<=point_count for the replacement to succeed. |
|
virtual |
bool LineKit::Equals | ( | LineKit const & | in_kit | ) | const |
size_t LineKit::GetPointCount | ( | ) | const |
Retrieves the number of points in this line.
|
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 LineKit::operator!= | ( | LineKit const & | in_kit | ) | const |
bool LineKit::operator== | ( | LineKit const & | in_kit | ) | const |
void LineKit::Set | ( | LineKit const & | in_kit | ) |
LineKit& LineKit::SetPoints | ( | PointArray const & | in_points | ) |
LineKit& LineKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the LineKit. 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. |
LineKit& LineKit::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. |
LineKit& LineKit::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. |
LineKit& LineKit::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 LineKit::Show | ( | LineKit & | out_kit | ) | const |
bool LineKit::ShowPoints | ( | PointArray & | out_points | ) | const |
bool LineKit::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 LineKit::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 LineKit::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 LineKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
bool LineKit::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. |
LineKit& LineKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
LineKit& LineKit::UnsetEverything | ( | ) |
LineKit& LineKit::UnsetPoints | ( | ) |
LineKit& LineKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
LineKit& LineKit::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. |
LineKit& LineKit::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. |
LineKit& LineKit::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. |