The EllipseKit class is a user space object. More...
#include <hps.h>
Public Member Functions | |
EllipseKit () | |
The default constructor creates an empty EllipseKit object. More... | |
EllipseKit (EllipseKit const &in_kit) | |
The copy constructor creates a new EllipseKit object that contains the same settings as the source EllipseKit. More... | |
EllipseKit (EllipseKit &&in_that) | |
The move constructor creates an EllipseKit by transferring the underlying impl of the rvalue reference to this EllipseKit thereby avoiding a copy and allocation. More... | |
EllipseKit & | operator= (EllipseKit &&in_that) |
The move assignment operator transfers the underlying impl of the rvalue reference to this EllipseKit thereby avoiding a copy. More... | |
virtual | ~EllipseKit () |
HPS::Type | ObjectType () const |
void | Consume (EllipseKit &in_kit) |
Copies the source EllipseKit into this EllipseKit and resets the source kit. More... | |
void | Set (EllipseKit const &in_kit) |
Copies the source EllipseKit into this EllipseKit. More... | |
void | Show (EllipseKit &out_kit) const |
Copies this EllipseKit into the given EllipseKit. More... | |
EllipseKit & | operator= (EllipseKit const &in_kit) |
Copies the source EllipseKit into this EllipseKit. More... | |
bool | Empty () const |
Indicates whether this EllipseKit has any values set on it. More... | |
bool | Equals (EllipseKit const &in_kit) const |
Check if the source EllipseKit is equivalent to this EllipseKit. More... | |
bool | operator== (EllipseKit const &in_kit) const |
Check if the source EllipseKit is equivalent to this EllipseKit. More... | |
bool | operator!= (EllipseKit const &in_kit) const |
Check if the source EllipseKit is not equivalent to this EllipseKit. More... | |
EllipseKit & | SetPriority (int in_priority) |
Assigns a specific drawing priority value to the EllipseKit. More... | |
EllipseKit & | UnsetPriority () |
Removes a drawing priority setting. More... | |
bool | ShowPriority (int &out_priority) const |
Shows the drawing priority. More... | |
EllipseKit & | SetCenter (Point const &in_center) |
Sets the center point for the ellipse. More... | |
EllipseKit & | SetMajor (Point const &in_major) |
Sets the intersection point of the major axis and the ellipse. More... | |
EllipseKit & | SetMinor (Point const &in_minor) |
Sets the intersection point of the minor axis and the ellipse. More... | |
EllipseKit & | UnsetCenter () |
Removes the center point for the ellipse. More... | |
EllipseKit & | UnsetMajor () |
Removes the intersection point of the major axis and the ellipse. More... | |
EllipseKit & | UnsetMinor () |
Removes the intersection point of the minor axis and the ellipse. More... | |
EllipseKit & | UnsetEverything () |
Removes all settings from this EllipseKit. More... | |
bool | ShowCenter (Point &out_center) const |
Shows the center point for the ellipse. More... | |
bool | ShowMajor (Point &out_major) const |
Shows the intersection point of the major axis and the ellipse. More... | |
bool | ShowMinor (Point &out_minor) const |
Shows the intersection point of the minor axis and the ellipse. More... | |
EllipseKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
Sets user data on this kit. More... | |
EllipseKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
Sets user data on this kit. More... | |
EllipseKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
Sets user data on this kit. More... | |
EllipseKit & | UnsetUserData (intptr_t in_index) |
Removes the user data at the given index from this kit. More... | |
EllipseKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
Removes the user data at the given indices from this kit. More... | |
EllipseKit & | UnsetUserData (IntPtrTArray const &in_indices) |
Removes the user data at the given indices from this kit. More... | |
EllipseKit & | UnsetAllUserData () |
Removes all user data from this kit. More... | |
size_t | ShowUserDataCount () const |
Get the number of user data indices set on this kit. More... | |
bool | ShowUserDataIndices (IntPtrTArray &out_indices) const |
Shows the indices of all user data set on this kit. More... | |
bool | ShowUserData (intptr_t in_index, ByteArray &out_data) const |
Shows the user data at a given index for this kit. More... | |
bool | ShowUserData (IntPtrTArray &out_indices, ByteArrayArray &out_data) const |
Shows all user data for this kit. More... | |
virtual HPS::Type | Type () const |
This function returns the true type of the underlying object. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
bool | HasType (HPS::Type in_mask) const |
This function indicates whether this Object has the given Type mask. More... | |
intptr_t | GetClassID () const |
Returns a unique identifier that is shared by all objects of the same class. More... | |
intptr_t | GetInstanceID () const |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
Static Public Member Functions | |
template<typename T > | |
static intptr_t | ClassID () |
Unique identifier for this class. More... | |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::EllipseKit |
The EllipseKit class is a user space object.
It is the kit analog to an EllipseKey.
HPS::EllipseKit::EllipseKit | ( | ) |
The default constructor creates an empty EllipseKit object.
HPS::EllipseKit::EllipseKit | ( | EllipseKit const & | in_kit | ) |
The copy constructor creates a new EllipseKit object that contains the same settings as the source EllipseKit.
in_kit | The source EllipseKit to copy. |
HPS::EllipseKit::EllipseKit | ( | EllipseKit && | in_that | ) |
The move constructor creates an EllipseKit by transferring the underlying impl of the rvalue reference to this EllipseKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to an EllipseKit to take the impl from. |
|
virtual |
|
inlinestaticinherited |
Unique identifier for this class.
Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.
void HPS::EllipseKit::Consume | ( | EllipseKit & | in_kit | ) |
Copies the source EllipseKit into this EllipseKit and resets the source kit.
in_kit | The source EllipseKit to consume. |
|
virtual |
Indicates whether this EllipseKit has any values set on it.
Reimplemented from HPS::Object.
bool HPS::EllipseKit::Equals | ( | EllipseKit const & | in_kit | ) | const |
Check if the source EllipseKit is equivalent to this EllipseKit.
in_kit | The source EllipseKit to compare to this EllipseKit. |
|
inherited |
Returns a unique identifier that is shared by all objects of the same class.
|
inherited |
Returns an identifier that can be used to identify which instance of a class an object is.
Different keys and controls will return the same value if they are backed by the same database resource.
|
inherited |
|
inlinevirtual |
bool HPS::EllipseKit::operator!= | ( | EllipseKit const & | in_kit | ) | const |
Check if the source EllipseKit is not equivalent to this EllipseKit.
in_kit | The source EllipseKit to compare to this EllipseKit. |
EllipseKit& HPS::EllipseKit::operator= | ( | EllipseKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this EllipseKit thereby avoiding a copy.
in_that | An rvalue reference to an EllipseKit to take the impl from. |
EllipseKit& HPS::EllipseKit::operator= | ( | EllipseKit const & | in_kit | ) |
Copies the source EllipseKit into this EllipseKit.
in_kit | The source EllipseKit to copy. |
bool HPS::EllipseKit::operator== | ( | EllipseKit const & | in_kit | ) | const |
Check if the source EllipseKit is equivalent to this EllipseKit.
in_kit | The source EllipseKit to compare to this EllipseKit. |
|
virtualinherited |
Resets this object to its initial, uninitialized state.
Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.
void HPS::EllipseKit::Set | ( | EllipseKit const & | in_kit | ) |
Copies the source EllipseKit into this EllipseKit.
in_kit | The source EllipseKit to copy. |
EllipseKit& HPS::EllipseKit::SetCenter | ( | Point const & | in_center | ) |
Sets the center point for the ellipse.
in_center | The center point for the ellipse. |
EllipseKit& HPS::EllipseKit::SetMajor | ( | Point const & | in_major | ) |
Sets the intersection point of the major axis and the ellipse.
in_major | The intersection point of the major axis and the ellipse. |
EllipseKit& HPS::EllipseKit::SetMinor | ( | Point const & | in_minor | ) |
Sets the intersection point of the minor axis and the ellipse.
in_minor | The intersection point of the minor axis and the ellipse. |
EllipseKit& HPS::EllipseKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the EllipseKit.
It affects the order in which the contents of this segment are drawn if and only if the rendering algorithm is set to Priority.
in_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
EllipseKit& HPS::EllipseKit::SetUserData | ( | intptr_t | in_index, |
size_t | in_bytes, | ||
byte const | in_data[] | ||
) |
Sets user data on this kit.
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. |
EllipseKit& HPS::EllipseKit::SetUserData | ( | intptr_t | in_index, |
ByteArray const & | in_data | ||
) |
Sets user data on this kit.
in_index | The index of the user data to set. |
in_data | The bytes of user data to set. |
EllipseKit& HPS::EllipseKit::SetUserData | ( | IntPtrTArray const & | in_indices, |
ByteArrayArray const & | in_data | ||
) |
Sets user data on this kit.
in_indices | An array of user data indices to set. |
in_data | An array of bytes of user data to set. |
void HPS::EllipseKit::Show | ( | EllipseKit & | out_kit | ) | const |
Copies this EllipseKit into the given EllipseKit.
out_kit | The EllipseKit to populate with the contents of this EllipseKit. |
bool HPS::EllipseKit::ShowCenter | ( | Point & | out_center | ) | const |
Shows the center point for the ellipse.
out_center | The center point for the ellipse. |
bool HPS::EllipseKit::ShowMajor | ( | Point & | out_major | ) | const |
Shows the intersection point of the major axis and the ellipse.
out_major | The intersection point of the major axis and the ellipse. |
bool HPS::EllipseKit::ShowMinor | ( | Point & | out_minor | ) | const |
Shows the intersection point of the minor axis and the ellipse.
out_minor | The intersection point of the minor axis and the ellipse. |
bool HPS::EllipseKit::ShowPriority | ( | int & | out_priority | ) | const |
Shows the drawing priority.
out_priority | The drawing priority, higher priority items are drawn on top of lower priority items. |
bool HPS::EllipseKit::ShowUserData | ( | intptr_t | in_index, |
ByteArray & | out_data | ||
) | const |
Shows the user data at a given index for this kit.
in_index | The index of the user data to show. |
out_data | The user data at the given index. |
bool HPS::EllipseKit::ShowUserData | ( | IntPtrTArray & | out_indices, |
ByteArrayArray & | out_data | ||
) | const |
Shows all user data for this kit.
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. |
size_t HPS::EllipseKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
bool HPS::EllipseKit::ShowUserDataIndices | ( | IntPtrTArray & | out_indices | ) | const |
Shows the indices of all user data set on this kit.
out_indices | The user data indices set on this kit. |
|
inlinevirtualinherited |
This function returns the true type of the underlying object.
This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
Reimplemented from HPS::Object.
EllipseKit& HPS::EllipseKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
EllipseKit& HPS::EllipseKit::UnsetCenter | ( | ) |
Removes the center point for the ellipse.
EllipseKit& HPS::EllipseKit::UnsetEverything | ( | ) |
Removes all settings from this EllipseKit.
EllipseKit& HPS::EllipseKit::UnsetMajor | ( | ) |
Removes the intersection point of the major axis and the ellipse.
EllipseKit& HPS::EllipseKit::UnsetMinor | ( | ) |
Removes the intersection point of the minor axis and the ellipse.
EllipseKit& HPS::EllipseKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
EllipseKit& HPS::EllipseKit::UnsetUserData | ( | intptr_t | in_index | ) |
Removes the user data at the given index from this kit.
in_index | The index of the user data to remove. |
EllipseKit& HPS::EllipseKit::UnsetUserData | ( | size_t | in_count, |
intptr_t const | in_indices[] | ||
) |
Removes the user data at the given indices from this kit.
in_count | The size of the following array. |
in_indices | The indices of the user data to remove. |
EllipseKit& HPS::EllipseKit::UnsetUserData | ( | IntPtrTArray const & | in_indices | ) |
Removes the user data at the given indices from this kit.
in_indices | The indices of the user data to remove. |
|
static |