#include <hps.h>

Public Member Functions | |
void | Consume (GridKit &in_kit) |
bool | Empty () const |
bool | Equals (GridKit const &in_kit) const |
GridKit () | |
GridKit (GridKit const &in_kit) | |
GridKit (GridKit &&in_that) | |
HPS::Type | ObjectType () const |
bool | operator!= (GridKit const &in_kit) const |
GridKit & | operator= (GridKit const &in_kit) |
GridKit & | operator= (GridKit &&in_that) |
bool | operator== (GridKit const &in_kit) const |
void | Set (GridKit const &in_kit) |
GridKit & | SetFirstCount (int in_first_count) |
GridKit & | SetFirstPoint (Point const &in_first_point) |
GridKit & | SetOrigin (Point const &in_origin) |
GridKit & | SetPriority (int in_priority) |
GridKit & | SetSecondCount (int in_second_count) |
GridKit & | SetSecondPoint (Point const &in_second_point) |
GridKit & | SetType (Grid::Type in_type) |
GridKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
GridKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
GridKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
void | Show (GridKit &out_kit) const |
bool | ShowFirstCount (int &out_first_count) const |
bool | ShowFirstPoint (Point &out_first_point) const |
bool | ShowOrigin (Point &out_origin) const |
bool | ShowPriority (int &out_priority) const |
bool | ShowSecondCount (int &out_second_count) const |
bool | ShowSecondPoint (Point &out_second_point) const |
bool | ShowType (Grid::Type &out_type) 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 |
GridKit & | UnsetAllUserData () |
GridKit & | UnsetEverything () |
GridKit & | UnsetFirstCount () |
GridKit & | UnsetFirstPoint () |
GridKit & | UnsetOrigin () |
GridKit & | UnsetPriority () |
GridKit & | UnsetSecondCount () |
GridKit & | UnsetSecondPoint () |
GridKit & | UnsetType () |
GridKit & | UnsetUserData (intptr_t in_index) |
GridKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
GridKit & | 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 () |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
Constructor & Destructor Documentation
HPS::GridKit::GridKit | ( | ) |
The default constructor creates an empty GridKit object.
HPS::GridKit::GridKit | ( | GridKit const & | in_kit | ) |
HPS::GridKit::GridKit | ( | GridKit && | in_that | ) |
Member Function Documentation
void HPS::GridKit::Consume | ( | GridKit & | in_kit | ) |
|
virtual |
Indicates whether this GridKit has any values set on it.
- Returns
- true if no values are set on this GridKit, false otherwise.
Reimplemented from HPS::Object.
bool HPS::GridKit::Equals | ( | GridKit const & | in_kit | ) | 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::GridKit::operator!= | ( | GridKit const & | in_kit | ) | const |
bool HPS::GridKit::operator== | ( | GridKit const & | in_kit | ) | const |
void HPS::GridKit::Set | ( | GridKit const & | in_kit | ) |
GridKit& HPS::GridKit::SetFirstCount | ( | int | in_first_count | ) |
Sets the first reference count for this GridKit, i.e., the number of grid elements along the vector determined by the first reference point. If the type of the grid is Grid::Type::Quadrilateral, there are three type of behavior depending on if the count is greater than zero, less than zero, or equal to zero. If the count is greater than zero, the count determines the finite number of grid lines which will intersect with the vector determined by the first reference point. If the count is less than zero, the count determines the finite number of grid lines which will intersect with the vector determined by the first reference point and additionally that same number of intersections along the negation of that vector. Lastly, if the count is zero, the grid will extend infinitely along the vector determined by the first reference point and its negation. If the type of the grid is Grid::Type::Radial, there are two types of behavior depending on if the count is greater than zero or equal to zero. If the count is greater than zero, it determines the finite number of circular arcs which will intersect with the radial vectors. If the count is equal to zero, there will be an infinite number of intersections along the radial arcs. Negative counts are invalid in this case.
- Parameters
-
in_first_count The count of the number of grid elements along the vector determined by the first reference point.
- Returns
- A reference to this GridKit.
Sets the first reference point for this GridKit. If the type of the grid is Grid::Type::Quadrilateral, this defines the first point along one of the vectors defining the grid (the other vector is determined by the second point). It also determines the spacing between the grid lines along the vector. If the type of the grid is Grid::Type::Radial, this defines the first point along the radius vector which will intersect with the circular grid arcs.
- Parameters
-
in_first_point The first reference point for this GridKit.
- Returns
- A reference to this GridKit.
GridKit& HPS::GridKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the GridKit. 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()
GridKit& HPS::GridKit::SetSecondCount | ( | int | in_second_count | ) |
Sets the second reference count for this GridKit, i.e., the number of grid elements along the vector determined by the second reference point. If the type of the grid is Grid::Type::Quadrilateral, there are three type of behavior depending on if the count is greater than zero, less than zero, or equal to zero. If the count is greater than zero, the count determines the finite number of grid lines which will intersect with the vector determined by the second reference point. If the count is less than zero, the count determines the finite number of grid lines which will intersect with the vector determined by the second reference point and additionally that same number of intersections along the negation of that vector. Lastly, if the count is zero, the grid will extend infinitely along the vector determined by the second reference point and its negation. If the type of the grid is Grid::Type::Radial, the count determines the number of radial vectors for the grid.
- Parameters
-
in_second_count The count of the number of grid elements along the vector determined by the second reference point.
- Returns
- A reference to this GridKit.
Sets the second reference point for this GridKit. If the type of the grid Grid::Type::Quadrilateral, this defines the first point along the second vector defining the grid (the other vector is determined by the first point). It also determines the spacing between the grid lines along the vector. If the type of the grid is Grid::Type::Radial, this defines the first point on the first circular arc which intersects with the radial vectors, and determines the spacing of the arcs along the radial vectors.
- Parameters
-
in_second_point The second reference point for this GridKit.
- Returns
- A reference to this GridKit.
GridKit& HPS::GridKit::SetType | ( | Grid::Type | in_type | ) |
GridKit& HPS::GridKit::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.
GridKit& HPS::GridKit::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.
GridKit& HPS::GridKit::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::GridKit::Show | ( | GridKit & | out_kit | ) | const |
bool HPS::GridKit::ShowFirstCount | ( | int & | out_first_count | ) | const |
bool HPS::GridKit::ShowFirstPoint | ( | Point & | out_first_point | ) | const |
bool HPS::GridKit::ShowOrigin | ( | Point & | out_origin | ) | const |
bool HPS::GridKit::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::GridKit::ShowSecondCount | ( | int & | out_second_count | ) | const |
bool HPS::GridKit::ShowSecondPoint | ( | Point & | out_second_point | ) | const |
bool HPS::GridKit::ShowType | ( | Grid::Type & | out_type | ) | const |
bool HPS::GridKit::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::GridKit::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::GridKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
bool HPS::GridKit::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.
GridKit& HPS::GridKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
- Returns
- A reference to this kit.
GridKit& HPS::GridKit::UnsetEverything | ( | ) |
GridKit& HPS::GridKit::UnsetFirstCount | ( | ) |
GridKit& HPS::GridKit::UnsetFirstPoint | ( | ) |
GridKit& HPS::GridKit::UnsetOrigin | ( | ) |
GridKit& HPS::GridKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
- Returns
- A reference to this GridKit.
GridKit& HPS::GridKit::UnsetSecondCount | ( | ) |
GridKit& HPS::GridKit::UnsetSecondPoint | ( | ) |
GridKit& HPS::GridKit::UnsetType | ( | ) |
GridKit& HPS::GridKit::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.
GridKit& HPS::GridKit::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.
GridKit& HPS::GridKit::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