API Search || Global Search
HPS::CircleShapeElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::CircleShapeElement:
HPS::ShapeElement HPS::Object

Public Member Functions

 CircleShapeElement ()
 
 CircleShapeElement (ShapeElement const &in_that)
 
 CircleShapeElement (CircleShapeElement const &in_that)
 
 CircleShapeElement (ShapePoint const &in_center, ShapePoint const &in_radius)
 
 CircleShapeElement (CircleShapeElement &&in_that)
 
HPS::Type ObjectType () const
 
CircleShapeElementoperator= (CircleShapeElement &&in_that)
 
CircleShapeElementSetCenter (ShapePoint const &in_center)
 
CircleShapeElementSetRadius (ShapePoint const &in_radius)
 
bool ShowCenter (ShapePoint &out_center) const
 
bool ShowRadius (ShapePoint &out_radius) 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::CircleShapeElement
 
- 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 CircleShapeElement class is a user space object. It is used to define circle elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

HPS::CircleShapeElement::CircleShapeElement ( )

The default constructor creates an empty CircleShapeElement object.

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

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

Parameters
in_thatThe source ShapeElement to copy.
HPS::CircleShapeElement::CircleShapeElement ( CircleShapeElement const &  in_that)

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

Parameters
in_thatThe source CircleShapeElement to copy.
HPS::CircleShapeElement::CircleShapeElement ( ShapePoint const &  in_center,
ShapePoint const &  in_radius 
)
explicit

This constructor creates a CircleShapeElement with the specified center and radius points.

Parameters
in_centerThe center point of the circle.
in_radiusThe radius of the circle.
HPS::CircleShapeElement::CircleShapeElement ( CircleShapeElement &&  in_that)

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

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

Member Function Documentation

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

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

Parameters
in_thatAn rvalue reference to a CircleShapeElement to take the impl from.
Returns
A reference to this CircleShapeElement.
CircleShapeElement& HPS::CircleShapeElement::SetCenter ( ShapePoint const &  in_center)

Sets the center point for this CircleShapeElement.

Parameters
in_centerThe center point of the circle.
CircleShapeElement& HPS::CircleShapeElement::SetRadius ( ShapePoint const &  in_radius)

Sets the radius point for this CircleShapeElement.

Parameters
in_radiusThe radius point of the circle.
bool HPS::CircleShapeElement::ShowCenter ( ShapePoint out_center) const

Shows the center point for this CircleShapeElement.

Parameters
out_centerThe center point for the circle.
Returns
true if a center point was set, false otherwise.
bool HPS::CircleShapeElement::ShowRadius ( ShapePoint out_radius) const

Shows the radius point for this CircleShapeElement.

Parameters
out_radiusThe radius point for the circle.
Returns
true if a radius was set, false otherwise.

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