HPS::LineShapeElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::LineShapeElement:
HPS::ShapeElement HPS::Object

Public Member Functions

 LineShapeElement ()
 
 LineShapeElement (ShapeElement const &in_that)
 
 LineShapeElement (LineShapeElement const &in_that)
 
 LineShapeElement (ShapePointArray const &in_points)
 
 LineShapeElement (size_t in_count, ShapePoint const in_points [])
 
 LineShapeElement (ShapePoint const &in_start, ShapePoint const &in_end)
 
 LineShapeElement (LineShapeElement &&in_that)
 
HPS::Type ObjectType () const
 
LineShapeElementoperator= (LineShapeElement &&in_that)
 
LineShapeElementSetPoints (ShapePointArray const &in_points)
 
LineShapeElementSetPoints (size_t in_count, ShapePoint const in_points [])
 
bool ShowPoints (ShapePointArray &out_points) 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::LineShapeElement
 
- 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 LineShapeElement class is a user space object. It is used to define line elements to make up shapes for text backgrounds.

Constructor & Destructor Documentation

◆ LineShapeElement() [1/7]

HPS::LineShapeElement::LineShapeElement ( )

The default constructor creates an empty LineShapeElement object.

◆ LineShapeElement() [2/7]

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

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

Parameters
in_thatThe source ShapeElement to copy.

◆ LineShapeElement() [3/7]

HPS::LineShapeElement::LineShapeElement ( LineShapeElement const &  in_that)

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

Parameters
in_thatThe source LineShapeElement to copy.

◆ LineShapeElement() [4/7]

HPS::LineShapeElement::LineShapeElement ( ShapePointArray const &  in_points)
explicit

This constructor creates a LineShapeElement with the specified points.

Parameters
in_pointsThe points making up the line.

◆ LineShapeElement() [5/7]

HPS::LineShapeElement::LineShapeElement ( size_t  in_count,
ShapePoint const  in_points[] 
)

This constructor creates a LineShapeElement with the specified points.

Parameters
in_countSize of the following array.
in_pointsThe points for the line.

◆ LineShapeElement() [6/7]

HPS::LineShapeElement::LineShapeElement ( ShapePoint const &  in_start,
ShapePoint const &  in_end 
)

This constructor creates a two-point LineShapeElement with the specified points.

Parameters
in_startThe start of the line.
in_endThe end of the line.

◆ LineShapeElement() [7/7]

HPS::LineShapeElement::LineShapeElement ( LineShapeElement &&  in_that)

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

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

Member Function Documentation

◆ ObjectType()

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

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

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

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

◆ SetPoints() [1/2]

LineShapeElement& HPS::LineShapeElement::SetPoints ( ShapePointArray const &  in_points)

Sets the points for this LineShapeElement.

Parameters
in_pointsThe points making up the line.

◆ SetPoints() [2/2]

LineShapeElement& HPS::LineShapeElement::SetPoints ( size_t  in_count,
ShapePoint const  in_points[] 
)

Sets the points for this LineShapeElement.

Parameters
in_countThe size of the following array.
in_pointsThe points making up the line.

◆ ShowPoints()

bool HPS::LineShapeElement::ShowPoints ( ShapePointArray &  out_points) const

Shows the points for this LineShapeElement.

Parameters
out_pointsThe points for this line
Returns
true if points were set, false otherwise.

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