Chemical Data Processing Library C++ API - Version 1.1.1
Public Types | Public Member Functions | List of all members
CDPL::Vis::PolygonPrimitive2D Class Reference

A graphics primitive representing a polygon. More...

#include <PolygonPrimitive2D.hpp>

+ Inheritance diagram for CDPL::Vis::PolygonPrimitive2D:

Public Types

typedef std::shared_ptr< PolygonPrimitive2DSharedPointer
 A reference-counted smart pointer [SHPTR] for dynamically allocated PolygonPrimitive2D instances. More...
 
- Public Types inherited from CDPL::Vis::GraphicsPrimitive2D
typedef std::shared_ptr< GraphicsPrimitive2DSharedPointer
 A reference-counted smart pointer [SHPTR] for dynamically allocated GraphicsPrimitive2D instances. More...
 

Public Member Functions

 PolygonPrimitive2D ()
 Constructs an undefined polygon primitive. More...
 
void render (Renderer2D &renderer) const
 Visualizes the graphics primitive by means of the Renderer2D instance renderer. More...
 
void setPen (const Pen &pen)
 Sets the pen defining the color, width, line style, cap style and join style of the polygon outline. More...
 
const PengetPen () const
 Returns the pen defining the color, width, line style, cap style and join style of the polygon outline. More...
 
void setBrush (const Brush &brush)
 Sets the brush defining the fill color and fill pattern. More...
 
const BrushgetBrush () const
 Returns the brush defining the fill color and fill pattern. More...
 
GraphicsPrimitive2D::SharedPointer clone () const
 Creates a dynamically allocated copy of the graphics primitive. More...
 
void getBounds (Rectangle2D &bounds, FontMetrics *font_metrics=0) const
 Calculates the bounds of the graphics primitive. More...
 
- Public Member Functions inherited from CDPL::Vis::PointArray2D
void translate (const Math::Vector2D &vec)
 Translates all points by vec. More...
 
void getBounds (Rectangle2D &bounds) const
 
- Public Member Functions inherited from CDPL::Vis::GraphicsPrimitive2D
virtual ~GraphicsPrimitive2D ()
 Virtual destructor. More...
 

Detailed Description

A graphics primitive representing a polygon.

Member Typedef Documentation

◆ SharedPointer

A reference-counted smart pointer [SHPTR] for dynamically allocated PolygonPrimitive2D instances.

Constructor & Destructor Documentation

◆ PolygonPrimitive2D()

CDPL::Vis::PolygonPrimitive2D::PolygonPrimitive2D ( )
inline

Constructs an undefined polygon primitive.

Member Function Documentation

◆ render()

void CDPL::Vis::PolygonPrimitive2D::render ( Renderer2D renderer) const
virtual

Visualizes the graphics primitive by means of the Renderer2D instance renderer.

Parameters
rendererThe renderer that performs the drawing operations.

Implements CDPL::Vis::GraphicsPrimitive2D.

◆ setPen()

void CDPL::Vis::PolygonPrimitive2D::setPen ( const Pen pen)

Sets the pen defining the color, width, line style, cap style and join style of the polygon outline.

Parameters
penThe pen defining the color, width, line style, cap style and join style of the polygon outline.

◆ getPen()

const Pen& CDPL::Vis::PolygonPrimitive2D::getPen ( ) const

Returns the pen defining the color, width, line style, cap style and join style of the polygon outline.

Returns
The pen defining the color, width, line style, cap style and join style of the polygon outline.

◆ setBrush()

void CDPL::Vis::PolygonPrimitive2D::setBrush ( const Brush brush)

Sets the brush defining the fill color and fill pattern.

Parameters
brushThe brush defining the fill color and fill pattern.

◆ getBrush()

const Brush& CDPL::Vis::PolygonPrimitive2D::getBrush ( ) const

Returns the brush defining the fill color and fill pattern.

Returns
The brush defining the fill color and fill pattern.

◆ clone()

GraphicsPrimitive2D::SharedPointer CDPL::Vis::PolygonPrimitive2D::clone ( ) const
virtual

Creates a dynamically allocated copy of the graphics primitive.

Returns
The copy of the graphics primitive.

Implements CDPL::Vis::GraphicsPrimitive2D.

◆ getBounds()

void CDPL::Vis::PolygonPrimitive2D::getBounds ( Rectangle2D bounds,
FontMetrics font_metrics = 0 
) const
virtual

Calculates the bounds of the graphics primitive.

Parameters
boundsThe object storing the calculated bounding box.
font_metricsThe font metrics object to use for bounds calculation (if required).

Implements CDPL::Vis::GraphicsPrimitive2D.


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