#include <hps.h>
The SphereKit class is a user space object. It is a kit analog to a SphereKey.
HPS::SphereKit::SphereKit |
( |
| ) |
|
The default constructor creates an empty SphereKit object.
HPS::SphereKit::SphereKit |
( |
SphereKit const & |
in_kit | ) |
|
The copy constructor creates a new SphereKit object that contains the same settings as the source SphereKit.
- Parameters
-
HPS::SphereKit::SphereKit |
( |
SphereKit && |
in_that | ) |
|
The move constructor creates a SphereKit by transferring the underlying impl of the rvalue reference to this SphereKit thereby avoiding a copy and allocation.
- Parameters
-
in_that | An rvalue reference to a SphereKit to take the impl from. |
void HPS::SphereKit::Consume |
( |
SphereKit & |
in_kit | ) |
|
bool HPS::SphereKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this SphereKit has any values set on it.
- Returns
- true if no values are set on this SphereKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::SphereKit::Equals |
( |
SphereKit const & |
in_kit | ) |
const |
Check if the source SphereKit is equivalent to this SphereKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
HPS::Type HPS::SphereKit::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::Kit.
bool HPS::SphereKit::operator!= |
( |
SphereKit const & |
in_kit | ) |
const |
Check if the source SphereKit is not equivalent to this SphereKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
The move assignment operator transfers the underlying impl of the rvalue reference to this SphereKit thereby avoiding a copy.
- Parameters
-
in_that | An rvalue reference to a SphereKit to take the impl from. |
- Returns
- A reference to this SphereKit.
bool HPS::SphereKit::operator== |
( |
SphereKit const & |
in_kit | ) |
const |
Check if the source SphereKit is equivalent to this SphereKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::SphereKit::Set |
( |
SphereKit const & |
in_kit | ) |
|
Sets the basis for the SphereKit.
- Parameters
-
in_vertical | The vector to use as the vertical axis for the SphereKit. |
in_horizontal | The vector to use as the horizontal axis for the SphereKit. |
- Returns
- A reference to this SphereKit.
SphereKit& HPS::SphereKit::SetPriority |
( |
int |
in_priority | ) |
|
Assigns a specific drawing priority value to the SphereKit. 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()
SphereKit& HPS::SphereKit::SetRadius |
( |
float |
in_radius | ) |
|
SphereKit& HPS::SphereKit::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.
SphereKit& HPS::SphereKit::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.
SphereKit& HPS::SphereKit::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::SphereKit::Show |
( |
SphereKit & |
out_kit | ) |
const |
bool HPS::SphereKit::ShowBasis |
( |
Vector & |
out_vertical, |
|
|
Vector & |
out_horizontal |
|
) |
| const |
Shows the basis for the SphereKit.
- Parameters
-
out_vertical | The vector to use as the vertical axis for the SphereKit. |
out_horizontal | The vector to use as the horizontal axis for the SphereKit. |
- Returns
- true if a basis was set, false otherwise.
bool HPS::SphereKit::ShowCenter |
( |
Point & |
out_center | ) |
const |
Shows the center point for this SphereKit.
- Parameters
-
out_center | The center point for the SphereKit. |
- Returns
- true if a center point was set, false otherwise.
bool HPS::SphereKit::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::SphereKit::ShowRadius |
( |
float & |
out_radius | ) |
const |
Shows the radius for the SphereKit.
- Parameters
-
- Returns
- true if a radius was set, false otherwise.
bool HPS::SphereKit::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::SphereKit::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::SphereKit::ShowUserDataCount |
( |
| ) |
const |
Get the number of user data indices set on this kit.
bool HPS::SphereKit::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.
SphereKit& HPS::SphereKit::UnsetAllUserData |
( |
| ) |
|
Removes all user data from this kit.
- Returns
- A reference to this kit.
SphereKit& HPS::SphereKit::UnsetEverything |
( |
| ) |
|
Removes a drawing priority setting.
- Returns
- A reference to this object.
SphereKit& HPS::SphereKit::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.
SphereKit& HPS::SphereKit::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.
SphereKit& HPS::SphereKit::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: