HPS::EllipseShapeElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::EllipseShapeElement:
HPS::ShapeElement HPS::Object

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
 
EllipseShapeElementoperator= (EllipseShapeElement &&in_that)
 
EllipseShapeElementSetCenter (ShapePoint const &in_center)
 
EllipseShapeElementSetMajorAxisPoint (ShapePoint const &in_major_axis_point)
 
EllipseShapeElementSetMinorAxisPoint (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
 
- Public Member Functions inherited from HPS::ShapeElement
bool Equals (ShapeElement const &in_that) const
 
bool operator!= (ShapeElement const &in_that) const
 
ShapeElementoperator= (ShapeElement &&in_that)
 
ShapeElementoperator= (ShapeElement const &in_that)
 
bool operator== (ShapeElement const &in_that) const
 
void Set (ShapeElement const &in_that)
 
ShapeElementSetDisjointed (bool in_state)
 
ShapeElementSetFill (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
 
- Public Member Functions inherited from HPS::Object
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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::EllipseShapeElement
 
- Static Public Attributes inherited from HPS::ShapeElement
static const HPS::Type staticType = HPS::Type::ShapeElement
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
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

◆ EllipseShapeElement() [1/5]

HPS::EllipseShapeElement::EllipseShapeElement ( )

The default constructor creates an empty EllipseShapeElement object.

◆ EllipseShapeElement() [2/5]

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_thatThe source ShapeElement to copy.

◆ EllipseShapeElement() [3/5]

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_thatThe source EllipseShapeElement to copy.

◆ EllipseShapeElement() [4/5]

HPS::EllipseShapeElement::EllipseShapeElement ( ShapePoint const &  in_center,
ShapePoint const &  in_major_axis_point,
ShapePoint const &  in_minor_axis_point 
)
explicit

This constructor creates a EllipseShapeElement with the specified point array.

Parameters
in_centerThe center of the ellipse.
in_major_axis_pointA point defining the major axis of the ellipse
in_minor_axis_pointA point defining the minor axis of the ellipse.

◆ EllipseShapeElement() [5/5]

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_thatAn rvalue reference to a EllipseShapeElement to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::EllipseShapeElement::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::ShapeElement.

◆ operator=()

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_thatAn rvalue reference to a EllipseShapeElement to take the impl from.
Returns
A reference to this EllipseShapeElement.

◆ SetCenter()

EllipseShapeElement& HPS::EllipseShapeElement::SetCenter ( ShapePoint const &  in_center)

Sets the points for this EllipseShapeElement.

Parameters
in_centerThe center point of the ellipse.

◆ SetMajorAxisPoint()

EllipseShapeElement& HPS::EllipseShapeElement::SetMajorAxisPoint ( ShapePoint const &  in_major_axis_point)

Sets a point on the major axis for this EllipseShapeElement.

Parameters
in_major_axis_pointThe point on the major axis of the ellipse.

◆ SetMinorAxisPoint()

EllipseShapeElement& HPS::EllipseShapeElement::SetMinorAxisPoint ( ShapePoint const &  in_minor_axis_point)

Sets a point on the minor axis for this EllipseShapeElement.

Parameters
in_minor_axis_pointThe point on the minor axis of the ellipse.

◆ ShowCenter()

bool HPS::EllipseShapeElement::ShowCenter ( ShapePoint out_center) const

Shows the center point for this EllipseShapeElement.

Parameters
out_centerThe center point for the ellipse.
Returns
true if a center point was set, false otherwise.

◆ ShowMajorAxisPoint()

bool HPS::EllipseShapeElement::ShowMajorAxisPoint ( ShapePoint out_major_axis_point) const

Shows the major axis point for this EllipseShapeElement.

Parameters
out_major_axis_pointThe major axis point for the ellipse.
Returns
true if a major axis point was set, false otherwise.

◆ ShowMinorAxisPoint()

bool HPS::EllipseShapeElement::ShowMinorAxisPoint ( ShapePoint out_minor_axis_point) const

Shows the minor axis point for this EllipseShapeElement.

Parameters
out_minor_axis_pointThe 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: