HPS::EllipticalArcShapeElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::EllipticalArcShapeElement:
HPS::ShapeElement HPS::Object

Public Member Functions

 EllipticalArcShapeElement ()
 
 EllipticalArcShapeElement (ShapeElement const &in_that)
 
 EllipticalArcShapeElement (EllipticalArcShapeElement const &in_that)
 
 EllipticalArcShapeElement (ShapePoint const &in_center, ShapePoint const &in_major_axis_point, ShapePoint const &in_minor_axis_point, float in_start=0.0f, float in_end=360.0f)
 
 EllipticalArcShapeElement (EllipticalArcShapeElement &&in_that)
 
HPS::Type ObjectType () const
 
EllipticalArcShapeElementoperator= (EllipticalArcShapeElement &&in_that)
 
EllipticalArcShapeElementSetCenter (ShapePoint const &in_center)
 
EllipticalArcShapeElementSetEnd (float in_end)
 
EllipticalArcShapeElementSetMajorAxisPoint (ShapePoint const &in_major_axis_point)
 
EllipticalArcShapeElementSetMinorAxisPoint (ShapePoint const &in_minor_axis_point)
 
EllipticalArcShapeElementSetStart (float in_start)
 
bool ShowCenter (ShapePoint &out_center) const
 
bool ShowEnd (float &out_end) const
 
bool ShowMajorAxisPoint (ShapePoint &out_major_axis_point) const
 
bool ShowMinorAxisPoint (ShapePoint &out_minor_axis_point) const
 
bool ShowStart (float &out_start) 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::EllipticalArcShapeElement
 
- 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 EllipticalArcShapeElement class is a user space object. It is used to define elliptical arc elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

◆ EllipticalArcShapeElement() [1/5]

HPS::EllipticalArcShapeElement::EllipticalArcShapeElement ( )

The default constructor creates an empty EllipticalArcShapeElement object.

◆ EllipticalArcShapeElement() [2/5]

HPS::EllipticalArcShapeElement::EllipticalArcShapeElement ( ShapeElement const &  in_that)

This constructor creates a EllipticalArcShapeElement 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 elliptical arc shape element. Otherwise the copy will fail and the resulting EllipticalArcShapeElement will be invalid.

Parameters
in_thatThe source ShapeElement to copy.

◆ EllipticalArcShapeElement() [3/5]

HPS::EllipticalArcShapeElement::EllipticalArcShapeElement ( EllipticalArcShapeElement const &  in_that)

The copy constructor creates a new EllipticalArcShapeElement object that contains the same settings as the source EllipticalArcShapeElement.

Parameters
in_thatThe source EllipticalArcShapeElement to copy.

◆ EllipticalArcShapeElement() [4/5]

HPS::EllipticalArcShapeElement::EllipticalArcShapeElement ( ShapePoint const &  in_center,
ShapePoint const &  in_major_axis_point,
ShapePoint const &  in_minor_axis_point,
float  in_start = 0.0f,
float  in_end = 360.0f 
)
explicit

This constructor creates a EllipticalArcShapeElement with the specified parameters.

Parameters
in_centerThe center point of the arc.
in_major_axis_pointA point defining the major axis of the arc.
in_minor_axis_pointA point defining the minor axis of the arc.
in_startThe start of the arc, in degrees.
in_endThe end of the arc, in degrees.

◆ EllipticalArcShapeElement() [5/5]

HPS::EllipticalArcShapeElement::EllipticalArcShapeElement ( EllipticalArcShapeElement &&  in_that)

The move constructor creates a EllipticalArcShapeElement by transferring the underlying impl of the rvalue reference to this EllipticalArcShapeElement thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a EllipticalArcShapeElement to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::EllipticalArcShapeElement::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=()

EllipticalArcShapeElement& HPS::EllipticalArcShapeElement::operator= ( EllipticalArcShapeElement &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this EllipticalArcShapeElement thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a EllipticalArcShapeElement to take the impl from.
Returns
A reference to this EllipticalArcShapeElement.

◆ SetCenter()

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

Sets the center point for this EllipticalArcShapeElement.

Parameters
in_centerThe center point of the arc.

◆ SetEnd()

EllipticalArcShapeElement& HPS::EllipticalArcShapeElement::SetEnd ( float  in_end)

Sets the end for this EllipticalArcShapeElement.

Parameters
in_endThe ending point of this arc, expressed in degrees

◆ SetMajorAxisPoint()

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

Sets the major axis point for this EllipticalArcShapeElement.

Parameters
in_major_axis_pointA point defining the major axis of the arc.

◆ SetMinorAxisPoint()

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

Sets the minor axis point for this EllipticalArcShapeElement.

Parameters
in_minor_axis_pointA point defining the minor axis of the arc.

◆ SetStart()

EllipticalArcShapeElement& HPS::EllipticalArcShapeElement::SetStart ( float  in_start)

Sets the start for this EllipticalArcShapeElement.

Parameters
in_startThe starting point of this arc, expressed in degrees

◆ ShowCenter()

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

Shows the center point for this EllipticalArcShapeElement.

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

◆ ShowEnd()

bool HPS::EllipticalArcShapeElement::ShowEnd ( float &  out_end) const

Shows the end point for this EllipticalArcShapeElement.

Parameters
out_endThe ending point of this arc, expressed in degrees
Returns
true if an end point was set, false otherwise.

◆ ShowMajorAxisPoint()

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

Shows the major axis point for this EllipticalArcShapeElement.

Parameters
out_major_axis_pointA point defining the major axis of the arc.
Returns
true if a major axis point was set, false otherwise.

◆ ShowMinorAxisPoint()

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

Shows the minor axis point for this EllipticalArcShapeElement.

Parameters
out_minor_axis_pointA point defining the minor axis of the arc.
Returns
true if a minor axis point was set, false otherwise.

◆ ShowStart()

bool HPS::EllipticalArcShapeElement::ShowStart ( float &  out_start) const

Shows the start point for this EllipticalArcShapeElement.

Parameters
out_startThe starting point of this arc, expressed in degrees
Returns
true if a start point was set, false otherwise.

The documentation for this class was generated from the following file: