#include <hps.h>

Public Member Functions | |
EllipseShapeElement () | |
EllipseShapeElement (ShapeElement const &in_that) | |
EllipseShapeElement (EllipseShapeElement const &in_that) | |
EllipseShapeElement (ShapePoint const &in_center, ShapePoint const &in_major_axis_point, ShapePoint const &in_minor_axis_point) | |
EllipseShapeElement (EllipseShapeElement &&in_that) | |
HPS::Type | ObjectType () const |
EllipseShapeElement & | operator= (EllipseShapeElement &&in_that) |
EllipseShapeElement & | SetCenter (ShapePoint const &in_center) |
EllipseShapeElement & | SetMajorAxisPoint (ShapePoint const &in_major_axis_point) |
EllipseShapeElement & | SetMinorAxisPoint (ShapePoint const &in_minor_axis_point) |
bool | ShowCenter (ShapePoint &out_center) const |
bool | ShowMajorAxisPoint (ShapePoint &out_major_axis_point) const |
bool | ShowMinorAxisPoint (ShapePoint &out_minor_axis_point) const |
![]() | |
bool | Equals (ShapeElement const &in_that) const |
bool | operator!= (ShapeElement const &in_that) const |
ShapeElement & | operator= (ShapeElement &&in_that) |
ShapeElement & | operator= (ShapeElement const &in_that) |
bool | operator== (ShapeElement const &in_that) const |
void | Set (ShapeElement const &in_that) |
ShapeElement & | SetDisjointed (bool in_state) |
ShapeElement & | SetFill (bool in_state) |
ShapeElement () | |
ShapeElement (ShapeElement const &in_that) | |
ShapeElement (ShapeElement &&in_that) | |
bool | ShowDisjointed (bool &out_state) const |
bool | ShowFill (bool &out_state) const |
![]() | |
virtual bool | Empty () 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 () |
virtual HPS::Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The EllipseShapeElement class is a user space object. It is used to define ellipse elements to make up shapes for text backgrounds.
Constructor & Destructor Documentation
HPS::EllipseShapeElement::EllipseShapeElement | ( | ) |
The default constructor creates an empty EllipseShapeElement object.
HPS::EllipseShapeElement::EllipseShapeElement | ( | ShapeElement const & | in_that | ) |
This constructor creates a EllipseShapeElement object that contains the same settings as the source ShapeElement. The copy will only be successful if the source shape element is really an upcast of an ellipse shape element. Otherwise the copy will fail and the resulting EllipseShapeElement will be invalid.
- Parameters
-
in_that The source ShapeElement to copy.
HPS::EllipseShapeElement::EllipseShapeElement | ( | EllipseShapeElement const & | in_that | ) |
The copy constructor creates a new EllipseShapeElement object that contains the same settings as the source EllipseShapeElement.
- Parameters
-
in_that The source EllipseShapeElement to copy.
|
explicit |
This constructor creates a EllipseShapeElement with the specified point array.
- Parameters
-
in_center The center of the ellipse. in_major_axis_point A point defining the major axis of the ellipse in_minor_axis_point A point defining the minor axis of the ellipse.
HPS::EllipseShapeElement::EllipseShapeElement | ( | EllipseShapeElement && | in_that | ) |
The move constructor creates a EllipseShapeElement by transferring the underlying impl of the rvalue reference to this EllipseShapeElement thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a EllipseShapeElement to take the impl from.
Member Function Documentation
|
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::ShapeElement.
EllipseShapeElement& HPS::EllipseShapeElement::operator= | ( | EllipseShapeElement && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this EllipseShapeElement thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a EllipseShapeElement to take the impl from.
- Returns
- A reference to this EllipseShapeElement.
EllipseShapeElement& HPS::EllipseShapeElement::SetCenter | ( | ShapePoint const & | in_center | ) |
Sets the points for this EllipseShapeElement.
- Parameters
-
in_center The center point of the ellipse.
EllipseShapeElement& HPS::EllipseShapeElement::SetMajorAxisPoint | ( | ShapePoint const & | in_major_axis_point | ) |
Sets a point on the major axis for this EllipseShapeElement.
- Parameters
-
in_major_axis_point The point on the major axis of the ellipse.
EllipseShapeElement& HPS::EllipseShapeElement::SetMinorAxisPoint | ( | ShapePoint const & | in_minor_axis_point | ) |
Sets a point on the minor axis for this EllipseShapeElement.
- Parameters
-
in_minor_axis_point The point on the minor axis of the ellipse.
bool HPS::EllipseShapeElement::ShowCenter | ( | ShapePoint & | out_center | ) | const |
Shows the center point for this EllipseShapeElement.
- Parameters
-
out_center The center point for the ellipse.
- Returns
- true if a center point was set, false otherwise.
bool HPS::EllipseShapeElement::ShowMajorAxisPoint | ( | ShapePoint & | out_major_axis_point | ) | const |
Shows the major axis point for this EllipseShapeElement.
- Parameters
-
out_major_axis_point The major axis point for the ellipse.
- Returns
- true if a major axis point was set, false otherwise.
bool HPS::EllipseShapeElement::ShowMinorAxisPoint | ( | ShapePoint & | out_minor_axis_point | ) | const |
Shows the minor axis point for this EllipseShapeElement.
- Parameters
-
out_minor_axis_point The minor axis point for the ellipse.
- Returns
- true if a minor axis point was set, false otherwise.
The documentation for this class was generated from the following file:
- include/hps.h