#include <hps.h>

Public Member Functions | |
CircularWedgeKit () | |
CircularWedgeKit (CircularWedgeKit const &in_kit) | |
CircularWedgeKit (CircularWedgeKit &&in_that) | |
void | Consume (CircularWedgeKit &in_kit) |
bool | Empty () const |
bool | Equals (CircularWedgeKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (CircularWedgeKit const &in_kit) const |
CircularWedgeKit & | operator= (CircularWedgeKit &&in_that) |
CircularWedgeKit & | operator= (CircularWedgeKit const &in_kit) |
bool | operator== (CircularWedgeKit const &in_kit) const |
void | Set (CircularWedgeKit const &in_kit) |
CircularWedgeKit & | SetEnd (Point const &in_end) |
CircularWedgeKit & | SetMiddle (Point const &in_middle) |
CircularWedgeKit & | SetPriority (int in_priority) |
CircularWedgeKit & | SetStart (Point const &in_start) |
CircularWedgeKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
CircularWedgeKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
CircularWedgeKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
void | Show (CircularWedgeKit &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 |
CircularWedgeKit & | UnsetAllUserData () |
CircularWedgeKit & | UnsetEnd () |
CircularWedgeKit & | UnsetEverything () |
CircularWedgeKit & | UnsetMiddle () |
CircularWedgeKit & | UnsetPriority () |
CircularWedgeKit & | UnsetStart () |
CircularWedgeKit & | UnsetUserData (intptr_t in_index) |
CircularWedgeKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
CircularWedgeKit & | 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::CircularWedgeKit |
![]() | |
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 CircularWedgeKit class is a user space object. It is a kit analog to a CircularWedgeKey.
Constructor & Destructor Documentation
◆ CircularWedgeKit() [1/3]
HPS::CircularWedgeKit::CircularWedgeKit | ( | ) |
The default constructor creates an empty CircularWedgeKit object.
◆ CircularWedgeKit() [2/3]
HPS::CircularWedgeKit::CircularWedgeKit | ( | CircularWedgeKit const & | in_kit | ) |
The copy constructor creates a new CircularWedgeKit object that contains the same settings as the source CircularWedgeKit.
- Parameters
-
in_kit The source CircularWedgeKit to copy.
◆ CircularWedgeKit() [3/3]
HPS::CircularWedgeKit::CircularWedgeKit | ( | CircularWedgeKit && | in_that | ) |
The move constructor creates a CircularWedgeKit by transferring the underlying impl of the rvalue reference to this CircularWedgeKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a CircularWedgeKit to take the impl from.
Member Function Documentation
◆ Consume()
void HPS::CircularWedgeKit::Consume | ( | CircularWedgeKit & | in_kit | ) |
Copies the source CircularWedgeKit into this CircularWedgeKit and resets the source kit.
- Parameters
-
in_kit The source CircularWedgeKit to consume.
◆ Empty()
|
virtual |
Indicates whether this CircularWedgeKit has any values set on it.
- Returns
- true if no values are set on this CircularWedgeKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::CircularWedgeKit::Equals | ( | CircularWedgeKit const & | in_kit | ) | const |
Check if the source CircularWedgeKit is equivalent to this CircularWedgeKit.
- Parameters
-
in_kit The source CircularWedgeKit to compare to this CircularWedgeKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Kit.
◆ operator!=()
bool HPS::CircularWedgeKit::operator!= | ( | CircularWedgeKit const & | in_kit | ) | const |
Check if the source CircularWedgeKit is not equivalent to this CircularWedgeKit.
- Parameters
-
in_kit The source CircularWedgeKit to compare to this CircularWedgeKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
CircularWedgeKit& HPS::CircularWedgeKit::operator= | ( | CircularWedgeKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CircularWedgeKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a CircularWedgeKit to take the impl from.
- Returns
- A reference to this CircularWedgeKit.
◆ operator=() [2/2]
CircularWedgeKit& HPS::CircularWedgeKit::operator= | ( | CircularWedgeKit const & | in_kit | ) |
Copies the source CircularWedgeKit into this CircularWedgeKit.
- Parameters
-
in_kit The source CircularWedgeKit to copy.
- Returns
- A reference to this CircularWedgeKit.
◆ operator==()
bool HPS::CircularWedgeKit::operator== | ( | CircularWedgeKit const & | in_kit | ) | const |
Check if the source CircularWedgeKit is equivalent to this CircularWedgeKit.
- Parameters
-
in_kit The source CircularWedgeKit to compare to this CircularWedgeKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::CircularWedgeKit::Set | ( | CircularWedgeKit const & | in_kit | ) |
Copies the source CircularWedgeKit into this CircularWedgeKit.
- Parameters
-
in_kit The source CircularWedgeKit to copy.
◆ SetEnd()
CircularWedgeKit& HPS::CircularWedgeKit::SetEnd | ( | Point const & | in_end | ) |
Sets the end point for this CircularWedgeKit. This is the point on the circumference of the circle at which the circular wedge ends.
- Parameters
-
in_end The end point for this CircularWedgeKit.
- Returns
- A reference to this CircularWedgeKit.
◆ SetMiddle()
CircularWedgeKit& HPS::CircularWedgeKit::SetMiddle | ( | Point const & | in_middle | ) |
Sets the middle point for this CircularWedgeKit. This is a point on the circumference of the circle between the start and end points for the circular wedge.
- Parameters
-
in_middle The middle point for this CircularWedgeKit.
- Returns
- A reference to this CircularWedgeKit.
◆ SetPriority()
CircularWedgeKit& HPS::CircularWedgeKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the CircularWedgeKit. 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()
◆ SetStart()
CircularWedgeKit& HPS::CircularWedgeKit::SetStart | ( | Point const & | in_start | ) |
Sets the start point for this CircularWedgeKit. This is the point on the circumference of the circle at which the circular wedge starts.
- Parameters
-
in_start The start point for this CircularWedgeKit.
- Returns
- A reference to this CircularWedgeKit.
◆ SetUserData() [1/3]
CircularWedgeKit& HPS::CircularWedgeKit::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.
◆ SetUserData() [2/3]
CircularWedgeKit& HPS::CircularWedgeKit::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.
◆ SetUserData() [3/3]
CircularWedgeKit& HPS::CircularWedgeKit::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.
◆ Show()
void HPS::CircularWedgeKit::Show | ( | CircularWedgeKit & | out_kit | ) | const |
Copies this CircularWedgeKit into the given CircularWedgeKit.
- Parameters
-
out_kit The CircularWedgeKit to populate with the contents of this CircularWedgeKit.
◆ ShowEnd()
bool HPS::CircularWedgeKit::ShowEnd | ( | Point & | out_end | ) | const |
Shows the end point for this CircularWedgeKit.
- Parameters
-
out_end The end point for this CircularWedgeKit.
- Returns
- true if an end point was set, false otherwise.
◆ ShowMiddle()
bool HPS::CircularWedgeKit::ShowMiddle | ( | Point & | out_middle | ) | const |
Shows the middle point for this CircularWedgeKit.
- Parameters
-
out_middle The middle point for this CircularWedgeKit.
- Returns
- true if a middle point was set, false otherwise.
◆ ShowPriority()
bool HPS::CircularWedgeKit::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.
◆ ShowStart()
bool HPS::CircularWedgeKit::ShowStart | ( | Point & | out_start | ) | const |
Shows the start point for this CircularWedgeKit.
- Parameters
-
out_start The start point for this CircularWedgeKit.
- Returns
- true if a start point was set, false otherwise.
◆ ShowUserData() [1/2]
bool HPS::CircularWedgeKit::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.
◆ ShowUserData() [2/2]
bool HPS::CircularWedgeKit::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.
◆ ShowUserDataCount()
size_t HPS::CircularWedgeKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
◆ ShowUserDataIndices()
bool HPS::CircularWedgeKit::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.
◆ UnsetAllUserData()
CircularWedgeKit& HPS::CircularWedgeKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
- Returns
- A reference to this kit.
◆ UnsetEnd()
CircularWedgeKit& HPS::CircularWedgeKit::UnsetEnd | ( | ) |
Removes the end point for this CircularWedgeKit.
- Returns
- A reference to this CircularWedgeKit.
◆ UnsetEverything()
CircularWedgeKit& HPS::CircularWedgeKit::UnsetEverything | ( | ) |
Removes all settings from the CircularWedgeKit.
- Returns
- A reference to this CircularWedgeKit.
◆ UnsetMiddle()
CircularWedgeKit& HPS::CircularWedgeKit::UnsetMiddle | ( | ) |
Removes the middle point for this CircularWedgeKit.
- Returns
- A reference to this CircularWedgeKit.
◆ UnsetPriority()
CircularWedgeKit& HPS::CircularWedgeKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetStart()
CircularWedgeKit& HPS::CircularWedgeKit::UnsetStart | ( | ) |
Removes the start point for this CircularWedgeKit.
- Returns
- A reference to this CircularWedgeKit.
◆ UnsetUserData() [1/3]
CircularWedgeKit& HPS::CircularWedgeKit::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.
◆ UnsetUserData() [2/3]
CircularWedgeKit& HPS::CircularWedgeKit::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.
◆ UnsetUserData() [3/3]
CircularWedgeKit& HPS::CircularWedgeKit::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