#include <hps.h>

Public Member Functions | |
CircularArcKit () | |
CircularArcKit (CircularArcKit const &in_kit) | |
CircularArcKit (CircularArcKit &&in_that) | |
void | Consume (CircularArcKit &in_kit) |
bool | Empty () const |
bool | Equals (CircularArcKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (CircularArcKit const &in_kit) const |
CircularArcKit & | operator= (CircularArcKit &&in_that) |
CircularArcKit & | operator= (CircularArcKit const &in_kit) |
bool | operator== (CircularArcKit const &in_kit) const |
void | Set (CircularArcKit const &in_kit) |
CircularArcKit & | SetEnd (Point const &in_end) |
CircularArcKit & | SetMiddle (Point const &in_middle) |
CircularArcKit & | SetPriority (int in_priority) |
CircularArcKit & | SetStart (Point const &in_start) |
CircularArcKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
CircularArcKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
CircularArcKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
void | Show (CircularArcKit &out_kit) const |
bool | ShowEnd (Point &out_end) const |
bool | ShowMiddle (Point &out_middle) const |
bool | ShowPriority (int &out_priority) const |
bool | ShowStart (Point &out_start) 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 |
CircularArcKit & | UnsetAllUserData () |
CircularArcKit & | UnsetEnd () |
CircularArcKit & | UnsetEverything () |
CircularArcKit & | UnsetMiddle () |
CircularArcKit & | UnsetPriority () |
CircularArcKit & | UnsetStart () |
CircularArcKit & | UnsetUserData (intptr_t in_index) |
CircularArcKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
CircularArcKit & | UnsetUserData (IntPtrTArray const &in_indices) |
![]() | |
virtual HPS::Type | Type () 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 () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::CircularArcKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::Kit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The CircularArcKit class is a user space object. It is a kit analog to a CircularArcKey.
Constructor & Destructor Documentation
HPS::CircularArcKit::CircularArcKit | ( | ) |
The default constructor creates an empty CircularArcKit object.
HPS::CircularArcKit::CircularArcKit | ( | CircularArcKit const & | in_kit | ) |
The copy constructor creates a new CircularArcKit object that contains the same settings as the source CircularArcKit.
- Parameters
-
in_kit The source CircularArcKit to copy.
HPS::CircularArcKit::CircularArcKit | ( | CircularArcKit && | in_that | ) |
The move constructor creates a CircularArcKit by transferring the underlying impl of the rvalue reference to this CircularArcKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a CircularArcKit to take the impl from.
Member Function Documentation
void HPS::CircularArcKit::Consume | ( | CircularArcKit & | in_kit | ) |
Copies the source CircularArcKit into this CircularArcKit and resets the source kit.
- Parameters
-
in_kit The source LineKit to consume.
|
virtual |
Indicates whether this CircularArcKit has any values set on it.
- Returns
- true if no values are set on this CircularArcKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::CircularArcKit::Equals | ( | CircularArcKit const & | in_kit | ) | const |
Check if the source CircularArcKit is equivalent to this CircularArcKit.
- Parameters
-
in_kit The source CircularArcKit to compare to this CircularArcKit.
- Returns
- true if the objects are equivalent, false otherwise.
bool HPS::CircularArcKit::operator!= | ( | CircularArcKit const & | in_kit | ) | const |
Check if the source CircularArcKit is not equivalent to this CircularArcKit.
- Parameters
-
in_kit The source CircularArcKit to compare to this CircularArcKit.
- Returns
- true if the objects are not equivalent, false otherwise.
CircularArcKit& HPS::CircularArcKit::operator= | ( | CircularArcKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CircularArcKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a CircularArcKit to take the impl from.
- Returns
- A reference to this CircularArcKit.
CircularArcKit& HPS::CircularArcKit::operator= | ( | CircularArcKit const & | in_kit | ) |
Copies the source CircularArcKit into this CircularArcKit.
- Parameters
-
in_kit The source CircularArcKit to copy.
- Returns
- A reference to this CircularArcKit.
bool HPS::CircularArcKit::operator== | ( | CircularArcKit const & | in_kit | ) | const |
Check if the source CircularArcKit is equivalent to this CircularArcKit.
- Parameters
-
in_kit The source CircularArcKit to compare to this CircularArcKit.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::CircularArcKit::Set | ( | CircularArcKit const & | in_kit | ) |
Copies the source CircularArcKit into this CircularArcKit.
- Parameters
-
in_kit The source CircularArcKit to copy.
CircularArcKit& HPS::CircularArcKit::SetEnd | ( | Point const & | in_end | ) |
Sets the end point for this CircularArcKit. This is the point on the circumference of the circle at which the circular arc ends.
- Parameters
-
in_end The end point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
CircularArcKit& HPS::CircularArcKit::SetMiddle | ( | Point const & | in_middle | ) |
Sets the middle point for this CircularArcKit. This is a point on the circumference of the circle between the start and end points for the circular arc.
- Parameters
-
in_middle The middle point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
CircularArcKit& HPS::CircularArcKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the CircularArcKit. It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.
- Parameters
-
in_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- A reference to this object.
- See also
- SubwindowKit::SetPriority()
- SubwindowKit::SetRenderingAlgorithm()
CircularArcKit& HPS::CircularArcKit::SetStart | ( | Point const & | in_start | ) |
Sets the start point for this CircularArcKit. This is the point on the circumference of the circle at which the circular arc starts.
- Parameters
-
in_start The start point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
CircularArcKit& HPS::CircularArcKit::SetUserData | ( | intptr_t | in_index, |
size_t | in_bytes, | ||
byte const | in_data[] | ||
) |
Sets user data on this kit.
- Parameters
-
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.
- Returns
- A reference to this kit.
CircularArcKit& HPS::CircularArcKit::SetUserData | ( | intptr_t | in_index, |
ByteArray const & | in_data | ||
) |
Sets user data on this kit.
- Parameters
-
in_index The index of the user data to set. in_data The bytes of user data to set.
- Returns
- A reference to this kit.
CircularArcKit& HPS::CircularArcKit::SetUserData | ( | IntPtrTArray const & | in_indices, |
ByteArrayArray const & | in_data | ||
) |
Sets user data on this kit.
- Parameters
-
in_indices An array of user data indices to set. in_data An array of bytes of user data to set.
- Returns
- A reference to this kit.
void HPS::CircularArcKit::Show | ( | CircularArcKit & | out_kit | ) | const |
Copies this CircularArcKit into the given CircularArcKit.
- Parameters
-
out_kit The CircularArcKit to populate with the contents of this CircularArcKit.
bool HPS::CircularArcKit::ShowEnd | ( | Point & | out_end | ) | const |
Shows the end point for this CircularArcKit.
- Parameters
-
out_end The end point for this CircularArcKit.
- Returns
- true if an end point was set, false otherwise.
bool HPS::CircularArcKit::ShowMiddle | ( | Point & | out_middle | ) | const |
Shows the middle point for this CircularArcKit.
- Parameters
-
out_middle The middle point for this CircularArcKit.
- Returns
- true if a middle point was set, false otherwise.
bool HPS::CircularArcKit::ShowPriority | ( | int & | out_priority | ) | const |
Shows the drawing priority.
- Parameters
-
out_priority The drawing priority, higher priority items are drawn on top of lower priority items.
- Returns
- true if the setting is valid, false otherwise.
bool HPS::CircularArcKit::ShowStart | ( | Point & | out_start | ) | const |
Shows the start point for this CircularArcKit.
- Parameters
-
out_start The start point for this CircularArcKit.
- Returns
- true if a start point was set, false otherwise.
bool HPS::CircularArcKit::ShowUserData | ( | intptr_t | in_index, |
ByteArray & | out_data | ||
) | const |
Shows the user data at a given index for this kit.
- Parameters
-
in_index The index of the user data to show. out_data The user data at the given index.
- Returns
- true if there is user data at the given index, false otherwise.
bool HPS::CircularArcKit::ShowUserData | ( | IntPtrTArray & | out_indices, |
ByteArrayArray & | out_data | ||
) | const |
Shows all user data for this kit.
- Parameters
-
out_indices An array of all user data indices set on this kit. out_data An array of all user data set on this kit.
- Returns
- true if there is user data on this kit, false otherwise.
size_t HPS::CircularArcKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
bool HPS::CircularArcKit::ShowUserDataIndices | ( | IntPtrTArray & | out_indices | ) | const |
Shows the indices of all user data set on this kit.
- Parameters
-
out_indices The user data indices set on this kit.
- Returns
- The number of user data indices set on this kit.
CircularArcKit& HPS::CircularArcKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
- Returns
- A reference to this kit.
CircularArcKit& HPS::CircularArcKit::UnsetEnd | ( | ) |
Removes the end point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
CircularArcKit& HPS::CircularArcKit::UnsetEverything | ( | ) |
Removes all settings from the CircularArcKit.
- Returns
- A reference to this CircularArcKit.
CircularArcKit& HPS::CircularArcKit::UnsetMiddle | ( | ) |
Removes the middle point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
CircularArcKit& HPS::CircularArcKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
- Returns
- A reference to this object.
CircularArcKit& HPS::CircularArcKit::UnsetStart | ( | ) |
Removes the start point for this CircularArcKit.
- Returns
- A reference to this CircularArcKit.
CircularArcKit& HPS::CircularArcKit::UnsetUserData | ( | intptr_t | in_index | ) |
Removes the user data at the given index from this kit.
- Parameters
-
in_index The index of the user data to remove.
- Returns
- A reference to this kit.
CircularArcKit& HPS::CircularArcKit::UnsetUserData | ( | size_t | in_count, |
intptr_t const | in_indices[] | ||
) |
Removes the user data at the given indices from this kit.
- Parameters
-
in_count The size of the following array. in_indices The indices of the user data to remove.
- Returns
- A reference to this kit.
CircularArcKit& HPS::CircularArcKit::UnsetUserData | ( | IntPtrTArray const & | in_indices | ) |
Removes the user data at the given indices from this kit.
- Parameters
-
in_indices The indices of the user data to remove.
- Returns
- A reference to this kit.
The documentation for this class was generated from the following file:
- include/hps.h