CDPL::Vis::LineSegmentListPrimitive2D Class Reference

2D graphics primitive representing a list of disjoint line segments. More...

#include <LineSegmentListPrimitive2D.hpp>

Inheritance diagram for CDPL::Vis::LineSegmentListPrimitive2D:

Public Types
typedef std::shared_ptr< LineSegmentListPrimitive2D >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated LineSegmentListPrimitive2D instances. More...
Public Types inherited from CDPL::Vis::PointArray2D
typedef std::shared_ptr< PointArray2D >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated PointArray2D instances. More...
Public Types inherited from CDPL::Vis::GraphicsPrimitive2D
typedef std::shared_ptr< GraphicsPrimitive2D >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated GraphicsPrimitive2D instances. More...

Public Member Functions
	LineSegmentListPrimitive2D ()
	Constructs an empty line segment list primitive. More...
void	render (Renderer2D &renderer) const
	Renders the line segments via renderer using the configured pen. More...
void	setPen (const Pen &pen)
	Sets the pen defining the color, width, line style and cap style of the line segments. More...
const Pen &	getPen () const
	Returns the pen defining the color, width, line style and cap style of the line segments. More...
GraphicsPrimitive2D::SharedPointer	clone () const
	Creates a dynamically allocated copy of this primitive. More...
void	getBounds (Rectangle2D &bounds, FontMetrics *font_mtrics=0) const
	Computes the axis-aligned bounding rectangle that contains all line-segment endpoints. 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
	Computes the axis-aligned bounding rectangle that contains all stored points. More...
Public Member Functions inherited from CDPL::Vis::GraphicsPrimitive2D
virtual	~GraphicsPrimitive2D ()
	Virtual destructor. More...

Detailed Description

2D graphics primitive representing a list of disjoint line segments.

Member Typedef Documentation

SharedPointer

typedef std::shared_ptr<LineSegmentListPrimitive2D> CDPL::Vis::LineSegmentListPrimitive2D::SharedPointer

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

Constructor & Destructor Documentation

LineSegmentListPrimitive2D()

CDPL::Vis::LineSegmentListPrimitive2D::LineSegmentListPrimitive2D ( )

inline

Constructs an empty line segment list primitive.

Member Function Documentation

render()

void CDPL::Vis::LineSegmentListPrimitive2D::render ( Renderer2D &  renderer ) const

virtual

Renders the line segments via renderer using the configured pen.

The point array is consumed in pairs: each pair of consecutive points defines one line segment.

Parameters

renderer

The renderer that performs the drawing operations.

Implements CDPL::Vis::GraphicsPrimitive2D.

setPen()

void CDPL::Vis::LineSegmentListPrimitive2D::setPen

(

const Pen &

pen

)

Sets the pen defining the color, width, line style and cap style of the line segments.

Parameters

pen	The pen defining the color, width, line style and cap style of the line segments.

getPen()

const Pen& CDPL::Vis::LineSegmentListPrimitive2D::getPen

(

)

const

Returns the pen defining the color, width, line style and cap style of the line segments.

Returns

The pen defining the color, width, line style and cap style of the line segments.

clone()

GraphicsPrimitive2D::SharedPointer CDPL::Vis::LineSegmentListPrimitive2D::clone ( ) const

virtual

Creates a dynamically allocated copy of this primitive.

Returns

A smart pointer to the copy.

Implements CDPL::Vis::GraphicsPrimitive2D.

getBounds()

void CDPL::Vis::LineSegmentListPrimitive2D::getBounds ( Rectangle2D &  bounds, FontMetrics *  font_mtrics = 0  ) const

virtual

Computes the axis-aligned bounding rectangle that contains all line-segment endpoints.

Parameters

bounds	The Rectangle2D instance storing the result.
font_mtrics	Unused for line-segment lists; included to satisfy the GraphicsPrimitive2D interface.

Implements CDPL::Vis::GraphicsPrimitive2D.

---

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

• LineSegmentListPrimitive2D.hpp