Public Member Functions | List of all members
HPS::SphereGlyphElement Class Reference

#include <hps.h>

Inheritance diagram for HPS::SphereGlyphElement:
HPS::GlyphElement HPS::Object

Public Member Functions

 SphereGlyphElement ()
 
 SphereGlyphElement (GlyphElement const &in_that)
 
 SphereGlyphElement (SphereGlyphElement const &in_that)
 
 SphereGlyphElement (SphereGlyphElement &&in_that)
 
SphereGlyphElementoperator= (SphereGlyphElement &&in_that)
 
HPS::Type ObjectType () const
 
- Public Member Functions inherited from HPS::GlyphElement
 GlyphElement ()
 
 GlyphElement (GlyphElement const &in_that)
 
 GlyphElement (GlyphElement &&in_that)
 
GlyphElementoperator= (GlyphElement &&in_that)
 
void Set (GlyphElement const &in_that)
 
GlyphElementoperator= (GlyphElement const &in_that)
 
bool Equals (GlyphElement const &in_that) const
 
bool operator== (GlyphElement const &in_that) const
 
bool operator!= (GlyphElement const &in_that) const
 
void SetFill (Glyph::Fill in_fill)
 
void SetIndexedColor (byte in_index)
 
void SetNormalColor ()
 
void SetExplicitColor (RGBAColor const &in_color)
 
bool ShowFill (Glyph::Fill &out_fill) const
 
bool ShowColor (Glyph::ColorSource &out_source, byte &out_index, RGBAColor &out_color) const
 
- Public Member Functions inherited from HPS::Object
 Object (Object const &that)
 
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual bool Empty () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The SphereGlyphElement class is a user space object. It is used to add ellipse elements to glyphs.

Constructor & Destructor Documentation

HPS::SphereGlyphElement::SphereGlyphElement ( )

The default constructor creates an empty SphereGlyphElement object.

HPS::SphereGlyphElement::SphereGlyphElement ( GlyphElement const &  in_that)

This constructor creates a SphereGlyphElement object that contains the same settings as the source GlyphElement. The copy will only be successful if the source glyph element is really an upcast of an ellipse glyph element. Otherwise the copy will fail and the resulting SphereGlyphElement will be invalid.

Parameters
in_thatThe source GlyphElement to copy.
HPS::SphereGlyphElement::SphereGlyphElement ( SphereGlyphElement const &  in_that)

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

Parameters
in_thatThe source SphereGlyphElement to copy.
HPS::SphereGlyphElement::SphereGlyphElement ( SphereGlyphElement &&  in_that)

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

Parameters
in_thatAn rvalue reference to an SphereGlyphElement to take the impl from.

Member Function Documentation

HPS::Type HPS::SphereGlyphElement::ObjectType ( ) const
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::GlyphElement.

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

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

Parameters
in_thatAn rvalue reference to an SphereGlyphElement to take the impl from.
Returns
A reference to this SphereGlyphElement.

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