#include <hps.h>
|
template<typename T > |
static intptr_t | ClassID () |
|
The EllipticalArcKit class is a user space object. It is the kit analog to an EllipticalArcKey.
HPS::EllipticalArcKit::EllipticalArcKit |
( |
| ) |
|
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
-
bool HPS::EllipticalArcKit::Empty |
( |
| ) |
const |
|
virtual |
HPS::Type HPS::EllipticalArcKit::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 EllipticalArcKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this EllipticalArcKit.
Sets the center point for the ellipse used to define the elliptcal arc.
- Parameters
-
in_center | The center point for the ellipse used to define the elliptical arc. |
- Returns
- A reference to this EllipticalArcKit.
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 noramlized 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.
Sets the intersection point of the major axis and the ellipse used to define the elliptcal 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.
Sets the intersection point of the minor axis and the ellipse used to define the elliptcal 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.
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()
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 noramlized 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.
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.
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.
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.
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.
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 noramlized parametric value on the ellipse at which the elliptical arc ends. |
- Returns
- true if a normalized parametric end value was set, false otherwise.
bool HPS::EllipticalArcKit::ShowMajor |
( |
Point & |
out_major | ) |
const |
Shows the intersection point of the major axis and the ellipse used to define the elliptcal 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.
bool HPS::EllipticalArcKit::ShowMinor |
( |
Point & |
out_minor | ) |
const |
Shows the intersection point of the minor axis and the ellipse used to define the elliptcal 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.
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.
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 noramlized parametric value on the ellipse at which the elliptical arc starts. |
- Returns
- true if a normalized parametric start value was set, false otherwise.
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.
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.
size_t HPS::EllipticalArcKit::ShowUserDataCount |
( |
| ) |
const |
Get the number of user data indices set on this kit.
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.
Removes all user data from this kit.
- Returns
- A reference to this kit.
Removes the center point for the ellipse used to define the elliptical arc.
- Returns
- A reference to this EllipticalArcKit.
Removes the normalized parametric value on the ellipse at which the elliptical arc ends.
- Returns
- A reference to this EllipticalArcKit.
Removes the intersection point of the major axis and the ellipse used to define the elliptical arc.
- Returns
- A reference to this EllipticalArcKit.
Removes the intersection point of the minor axis and the ellipse used to define the elliptical arc.
- Returns
- A reference to this EllipticalArcKit.
Removes a drawing priority setting.
- Returns
- A reference to this object.
Removes the normalized parametric value on the ellipse at which the elliptical arc starts.
- Returns
- A reference to this EllipticalArcKit.
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.
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.
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: