#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::EllipticalArcKey |
|
static const HPS::Type | staticType = HPS::Type::GeometryKey |
|
static const HPS::Type | staticType = HPS::Type::Key |
|
static const HPS::Type | staticType = HPS::Type::None |
|
|
template<typename T > |
static intptr_t | ClassID () |
|
The EllipticalArcKey class is a smart pointer to a database object. It is a handle to an elliptical arc inserted via SegmentKey::InsertEllipticalArc.
◆ EllipticalArcKey() [1/4]
HPS::EllipticalArcKey::EllipticalArcKey |
( |
| ) |
|
The default constructor creates an uninitialized EllipticalArcKey object. The Type() function will return Type::None.
◆ EllipticalArcKey() [2/4]
HPS::EllipticalArcKey::EllipticalArcKey |
( |
Key const & |
in_that | ) |
|
|
explicit |
This constructor creates an EllipticalArcKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an EllipticalArc key. Otherwise the copy will fail and the resulting EllipticalArcKey will be invalid.
- Parameters
-
in_key | The source Key to copy. |
◆ EllipticalArcKey() [3/4]
◆ EllipticalArcKey() [4/4]
The move constructor creates an EllipticalArcKey by transferring the underlying impl of the rvalue reference to this EllipticalArcKey thereby avoiding a copy and allocation.
- Parameters
-
◆ Consume()
Completely replaces all settings on this EllipticalArcKey with those set on the specified kit and resets the kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this EllipticalArcKey. |
◆ ObjectType()
HPS::Type HPS::EllipticalArcKey::ObjectType |
( |
| ) |
const |
|
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::GeometryKey.
◆ operator=() [1/2]
◆ operator=() [2/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this EllipticalArcKey thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this EllipticalArcKey.
◆ Set()
Replace those settings on this EllipticalArcKey with those set on the specified kit.
- Parameters
-
in_kit | The kit from which to get the settings to replace on this EllipticalArcKey. |
◆ SetCenter()
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 EllipticalArcKey.
◆ SetEnd()
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 EllipticalArcKey.
◆ SetMajor()
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 EllipticalArcKey.
◆ SetMinor()
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 EllipticalArcKey.
◆ SetStart()
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 EllipticalArcKey.
◆ Show()
◆ ShowCenter()
bool HPS::EllipticalArcKey::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::EllipticalArcKey::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::EllipticalArcKey::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::EllipticalArcKey::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.
◆ ShowStart()
bool HPS::EllipticalArcKey::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.
The documentation for this class was generated from the following file: