#include <hps.h>
|
template<typename T > |
static intptr_t | ClassID () |
|
The CircularWedgeKit class is a user space object. It is a kit analog to a CircularWedgeKey.
HPS::CircularWedgeKit::CircularWedgeKit |
( |
| ) |
|
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
-
bool HPS::CircularWedgeKit::Empty |
( |
| ) |
const |
|
virtual |
HPS::Type HPS::CircularWedgeKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
The move assignment operator transfers the underlying impl of the rvalue reference to this CircularWedgeKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this CircularWedgeKit.
Sets the end point for this CircularWedgeKit. This is the point on the circumference of the circle at which the circular wedge ends.
- Parameters
-
- Returns
- A reference to this CircularWedgeKit.
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
-
- Returns
- A reference to this CircularWedgeKit.
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()
Sets the start point for this CircularWedgeKit. This is the point on the circumference of the circle at which the circular wedge starts.
- Parameters
-
- Returns
- A reference to this CircularWedgeKit.
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.
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.
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.
bool HPS::CircularWedgeKit::ShowEnd |
( |
Point & |
out_end | ) |
const |
Shows the end point for this CircularWedgeKit.
- Parameters
-
- Returns
- true if an end point was set, false otherwise.
bool HPS::CircularWedgeKit::ShowMiddle |
( |
Point & |
out_middle | ) |
const |
Shows the middle point for this CircularWedgeKit.
- Parameters
-
- Returns
- true if a middle point was set, false otherwise.
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.
bool HPS::CircularWedgeKit::ShowStart |
( |
Point & |
out_start | ) |
const |
Shows the start point for this CircularWedgeKit.
- Parameters
-
- Returns
- true if a start point was set, false otherwise.
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.
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. |
in_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::CircularWedgeKit::ShowUserDataCount |
( |
| ) |
const |
Get the number of user data indices set on this kit.
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.
Removes all user data from this kit.
- Returns
- A reference to this kit.
Removes a drawing priority setting.
- Returns
- A reference to this object.
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.
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.
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: