#include <hps.h>

Public Member Functions | |
void | Consume (EllipticalArcKit &in_kit) |
EllipticalArcKit () | |
EllipticalArcKit (EllipticalArcKit const &in_kit) | |
EllipticalArcKit (EllipticalArcKit &&in_that) | |
bool | Empty () const |
bool | Equals (EllipticalArcKit const &in_kit) const |
HPS::Type | ObjectType () const |
bool | operator!= (EllipticalArcKit const &in_kit) const |
EllipticalArcKit & | operator= (EllipticalArcKit &&in_that) |
EllipticalArcKit & | operator= (EllipticalArcKit const &in_kit) |
bool | operator== (EllipticalArcKit const &in_kit) const |
void | Set (EllipticalArcKit const &in_kit) |
EllipticalArcKit & | SetCenter (Point const &in_center) |
EllipticalArcKit & | SetEnd (float in_end) |
EllipticalArcKit & | SetMajor (Point const &in_major) |
EllipticalArcKit & | SetMinor (Point const &in_minor) |
EllipticalArcKit & | SetPriority (int in_priority) |
EllipticalArcKit & | SetStart (float in_start) |
EllipticalArcKit & | SetUserData (intptr_t in_index, size_t in_bytes, byte const in_data[]) |
EllipticalArcKit & | SetUserData (intptr_t in_index, ByteArray const &in_data) |
EllipticalArcKit & | SetUserData (IntPtrTArray const &in_indices, ByteArrayArray const &in_data) |
void | Show (EllipticalArcKit &out_kit) const |
bool | ShowCenter (Point &out_center) const |
bool | ShowEnd (float &out_end) const |
bool | ShowMajor (Point &out_major) const |
bool | ShowMinor (Point &out_minor) const |
bool | ShowPriority (int &out_priority) const |
bool | ShowStart (float &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 |
EllipticalArcKit & | UnsetAllUserData () |
EllipticalArcKit & | UnsetCenter () |
EllipticalArcKit & | UnsetEnd () |
EllipticalArcKit & | UnsetEverything () |
EllipticalArcKit & | UnsetMajor () |
EllipticalArcKit & | UnsetMinor () |
EllipticalArcKit & | UnsetPriority () |
EllipticalArcKit & | UnsetStart () |
EllipticalArcKit & | UnsetUserData (intptr_t in_index) |
EllipticalArcKit & | UnsetUserData (size_t in_count, intptr_t const in_indices[]) |
EllipticalArcKit & | 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::EllipticalArcKit |
![]() | |
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 EllipticalArcKit class is a user space object. It is the kit analog to an EllipticalArcKey.
Constructor & Destructor Documentation
◆ EllipticalArcKit() [1/3]
HPS::EllipticalArcKit::EllipticalArcKit | ( | ) |
The default constructor creates an empty EllipticalArcKit object.
◆ EllipticalArcKit() [2/3]
HPS::EllipticalArcKit::EllipticalArcKit | ( | EllipticalArcKit const & | in_kit | ) |
The copy constructor creates a new EllipticalArcKit object that contains the same settings as the source EllipticalArcKit.
- Parameters
-
in_kit The source EllipticalArcKit to copy.
◆ EllipticalArcKit() [3/3]
HPS::EllipticalArcKit::EllipticalArcKit | ( | EllipticalArcKit && | in_that | ) |
The move constructor creates an EllipticalArcKit by transferring the underlying impl of the rvalue reference to this EllipticalArcKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an EllipticalArcKit to take the impl from.
Member Function Documentation
◆ Consume()
void HPS::EllipticalArcKit::Consume | ( | EllipticalArcKit & | in_kit | ) |
Copies the source EllipticalArcKit into this EllipticalArcKit and resets the source kit.
- Parameters
-
in_kit The source EllipticalArcKit to consume.
◆ Empty()
|
virtual |
Indicates whether this EllipticalArcKit has any values set on it.
- Returns
- true if no values are set on this EllipticalArcKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::EllipticalArcKit::Equals | ( | EllipticalArcKit const & | in_kit | ) | const |
Check if the source EllipticalArcKit is equivalent to this EllipticalArcKit.
- Parameters
-
in_kit The source EllipticalArcKit to compare to this EllipticalArcKit.
- 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::EllipticalArcKit::operator!= | ( | EllipticalArcKit const & | in_kit | ) | const |
Check if the source EllipticalArcKit is not equivalent to this EllipticalArcKit.
- Parameters
-
in_kit The source EllipticalArcKit to compare to this EllipticalArcKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
EllipticalArcKit& HPS::EllipticalArcKit::operator= | ( | EllipticalArcKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this EllipticalArcKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an EllipticalArcKit to take the impl from.
- Returns
- A reference to this EllipticalArcKit.
◆ operator=() [2/2]
EllipticalArcKit& HPS::EllipticalArcKit::operator= | ( | EllipticalArcKit const & | in_kit | ) |
Copies the source EllipticalArcKit into this EllipticalArcKit.
- Parameters
-
in_kit The source EllipticalArcKit to copy.
- Returns
- A reference to this EllipticalArcKit.
◆ operator==()
bool HPS::EllipticalArcKit::operator== | ( | EllipticalArcKit const & | in_kit | ) | const |
Check if the source EllipticalArcKit is equivalent to this EllipticalArcKit.
- Parameters
-
in_kit The source EllipticalArcKit to compare to this EllipticalArcKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::EllipticalArcKit::Set | ( | EllipticalArcKit const & | in_kit | ) |
Copies the source EllipticalArcKit into this EllipticalArcKit.
- Parameters
-
in_kit The source EllipticalArcKit to copy.
◆ SetCenter()
EllipticalArcKit& HPS::EllipticalArcKit::SetCenter | ( | Point const & | in_center | ) |
Sets the center point for the ellipse used to define the elliptical arc.
- Parameters
-
in_center The center point for the ellipse used to define the elliptical arc.
- Returns
- A reference to this EllipticalArcKit.
◆ SetEnd()
EllipticalArcKit& HPS::EllipticalArcKit::SetEnd | ( | float | in_end | ) |
Sets the normalized parametric value on the ellipse at which the elliptical arc ends. The value should be in the range [0.0f,1.0f] and be larger than the start value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.
- Parameters
-
in_end The normalized parametric value on the ellipse at which the elliptical arc ends. This value should be in the range [0.0f,1.0f] and be larger than the start value.
- Returns
- A reference to this EllipticalArcKit.
◆ SetMajor()
EllipticalArcKit& HPS::EllipticalArcKit::SetMajor | ( | Point const & | in_major | ) |
Sets the intersection point of the major axis and the ellipse used to define the elliptical arc.
- Parameters
-
in_major The intersection point of the major axis and the ellipse used to define the elliptical arc.
- Returns
- A reference to this EllipticalArcKit.
◆ SetMinor()
EllipticalArcKit& HPS::EllipticalArcKit::SetMinor | ( | Point const & | in_minor | ) |
Sets the intersection point of the minor axis and the ellipse used to define the elliptical arc.
- Parameters
-
in_minor The intersection point of the minor axis and the ellipse used to define the elliptical arc.
- Returns
- A reference to this EllipticalArcKit.
◆ SetPriority()
EllipticalArcKit& HPS::EllipticalArcKit::SetPriority | ( | int | in_priority | ) |
Assigns a specific drawing priority value to the EllipticalArcKit. 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()
EllipticalArcKit& HPS::EllipticalArcKit::SetStart | ( | float | in_start | ) |
Sets the normalized parametric value on the ellipse at which the elliptical arc starts. The value should be in the range [0.0f,1.0f] and be smaller than the end value. It is defined such that 0.0f is the point where the major axis intersects the ellipse, and as the value increases it passes through the point at which the minor axis intersects the ellipse (0.25f), and that 1.0f maps to the same point as 0.0f.
- Parameters
-
in_start The normalized parametric value on the ellipse at which the elliptical arc starts. This value should be in the range [0.0f,1.0f] and be smaller than the end value.
- Returns
- A reference to this EllipticalArcKit.
◆ SetUserData() [1/3]
EllipticalArcKit& HPS::EllipticalArcKit::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]
EllipticalArcKit& HPS::EllipticalArcKit::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]
EllipticalArcKit& HPS::EllipticalArcKit::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::EllipticalArcKit::Show | ( | EllipticalArcKit & | out_kit | ) | const |
Copies this EllipticalArcKit into the given EllipticalArcKit.
- Parameters
-
out_kit The EllipticalArcKit to populate with the contents of this EllipticalArcKit.
◆ ShowCenter()
bool HPS::EllipticalArcKit::ShowCenter | ( | Point & | out_center | ) | const |
Shows the center point for the ellipse used to define the elliptical arc.
- Parameters
-
out_center The center point for the ellipse used to define the elliptical arc.
- Returns
- true if a center was set, false otherwise.
◆ ShowEnd()
bool HPS::EllipticalArcKit::ShowEnd | ( | float & | out_end | ) | const |
Shows the normalized parametric value on the ellipse at which the elliptical arc ends.
- Parameters
-
out_end The normalized parametric value on the ellipse at which the elliptical arc ends.
- Returns
- true if a normalized parametric end value was set, false otherwise.
◆ ShowMajor()
bool HPS::EllipticalArcKit::ShowMajor | ( | Point & | out_major | ) | const |
Shows the intersection point of the major axis and the ellipse used to define the elliptical arc.
- Parameters
-
out_major The intersection point of the major axis and the ellipse used to define the elliptical arc.
- Returns
- true if an intersection point with the major axis was set, false otherwise.
◆ ShowMinor()
bool HPS::EllipticalArcKit::ShowMinor | ( | Point & | out_minor | ) | const |
Shows the intersection point of the minor axis and the ellipse used to define the elliptical arc.
- Parameters
-
out_minor The intersection point of the minor axis and the ellipse used to define the elliptical arc.
- Returns
- true if an intersection point with the minor axis was set, false otherwise.
◆ ShowPriority()
bool HPS::EllipticalArcKit::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::EllipticalArcKit::ShowStart | ( | float & | out_start | ) | const |
Shows the normalized parametric value on the ellipse at which the elliptical arc starts.
- Parameters
-
out_start The normalized parametric value on the ellipse at which the elliptical arc starts.
- Returns
- true if a normalized parametric start value was set, false otherwise.
◆ ShowUserData() [1/2]
bool HPS::EllipticalArcKit::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::EllipticalArcKit::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::EllipticalArcKit::ShowUserDataCount | ( | ) | const |
Get the number of user data indices set on this kit.
◆ ShowUserDataIndices()
bool HPS::EllipticalArcKit::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()
EllipticalArcKit& HPS::EllipticalArcKit::UnsetAllUserData | ( | ) |
Removes all user data from this kit.
- Returns
- A reference to this kit.
◆ UnsetCenter()
EllipticalArcKit& HPS::EllipticalArcKit::UnsetCenter | ( | ) |
Removes the center point for the ellipse used to define the elliptical arc.
- Returns
- A reference to this EllipticalArcKit.
◆ UnsetEnd()
EllipticalArcKit& HPS::EllipticalArcKit::UnsetEnd | ( | ) |
Removes the normalized parametric value on the ellipse at which the elliptical arc ends.
- Returns
- A reference to this EllipticalArcKit.
◆ UnsetEverything()
EllipticalArcKit& HPS::EllipticalArcKit::UnsetEverything | ( | ) |
Removes all settings from this EllipticalArcKit.
- Returns
- A reference to this EllipticalArcKit.
◆ UnsetMajor()
EllipticalArcKit& HPS::EllipticalArcKit::UnsetMajor | ( | ) |
Removes the intersection point of the major axis and the ellipse used to define the elliptical arc.
- Returns
- A reference to this EllipticalArcKit.
◆ UnsetMinor()
EllipticalArcKit& HPS::EllipticalArcKit::UnsetMinor | ( | ) |
Removes the intersection point of the minor axis and the ellipse used to define the elliptical arc.
- Returns
- A reference to this EllipticalArcKit.
◆ UnsetPriority()
EllipticalArcKit& HPS::EllipticalArcKit::UnsetPriority | ( | ) |
Removes a drawing priority setting.
- Returns
- A reference to this object.
◆ UnsetStart()
EllipticalArcKit& HPS::EllipticalArcKit::UnsetStart | ( | ) |
Removes the normalized parametric value on the ellipse at which the elliptical arc starts.
- Returns
- A reference to this EllipticalArcKit.
◆ UnsetUserData() [1/3]
EllipticalArcKit& HPS::EllipticalArcKit::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]
EllipticalArcKit& HPS::EllipticalArcKit::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]
EllipticalArcKit& HPS::EllipticalArcKit::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