cturtle::Polygon Class Reference

The polygon class merely holds a vector of points and a function to draw this series to an image. Please note that the contained series of points must be in either clockwise(CW) or counterclockwise(CCW) order! More...

#include <CTurtle.hpp>

Inheritance diagram for cturtle::Polygon:

Collaboration diagram for cturtle::Polygon:

Public Member Functions
	Polygon ()=default
	Empty default constructor.
	Polygon (const std::initializer_list< Point > &init)
	Initializer list instructor which assigns the points to the contents of the specified initializer list.
	Polygon (std::vector< Point > copy, const Color &fillColor, int outlineWidth=0, const Color &outlineColor=Color())
	A copy constructor for another vector of points.
	Polygon (const Polygon &other)=default
	A copy constructor for another polygon.
AbstractDrawableObject *	copy () const override
	~Polygon () override=default
	Empty de-constructor.
void	draw (const Transform &t, Image &imgRef) const override
	This function is intended to draw all applicable geometry in this object to the specified image, with the specified transform, with the specified color. This function is intended to be overloaded by child classes to draw applicable geometry to an image, acting as a canvas.
Public Member Functions inherited from cturtle::AbstractDrawableObject
virtual	~AbstractDrawableObject ()=default
	Empty– virtual– default de-constructor.

Public Attributes
std::vector< Point >	points
Public Attributes inherited from cturtle::AbstractDrawableObject
Color	fillColor
Color	outlineColor
int	outlineWidth = 0

Additional Inherited Members
Protected Member Functions inherited from cturtle::AbstractDrawableObject
	AbstractDrawableObject ()=default
	Empty default constructor.

Detailed Description

The polygon class merely holds a vector of points and a function to draw this series to an image. Please note that the contained series of points must be in either clockwise(CW) or counterclockwise(CCW) order!

Constructor & Destructor Documentation

Polygon() [1/3]

cturtle::Polygon::Polygon ( const std::initializer_list< Point > & init )

inline

Initializer list instructor which assigns the points to the contents of the specified initializer list.

Parameters

The	initializer list from where points are retrieved.

Polygon() [2/3]

cturtle::Polygon::Polygon ( std::vector< Point > copy, const Color & fillColor, int outlineWidth = 0, const Color & outlineColor = Color() )

inline

A copy constructor for another vector of points.

Parameters

copy	A vector from which to derive points.

Polygon() [3/3]

cturtle::Polygon::Polygon ( const Polygon & other )

default

A copy constructor for another polygon.

Parameters

other

Another polygon from which to derive points.

Member Function Documentation

copy()

AbstractDrawableObject * cturtle::Polygon::copy ( ) const

inlineoverridevirtual

Returns a copy of this polygon allocated with the new keyword. Must be deleted at the responsibility of the invoker.

Implements cturtle::AbstractDrawableObject.

draw()

void cturtle::Polygon::draw ( const Transform & t, Image & imgRef ) const

inlineoverridevirtual

This function is intended to draw all applicable geometry in this object to the specified image, with the specified transform, with the specified color. This function is intended to be overloaded by child classes to draw applicable geometry to an image, acting as a canvas.

Parameters

t	The transform at which to draw the geometry.
imgRef	The canvas on which to draw.
c	The color with to draw the geometry.

Implements cturtle::AbstractDrawableObject.

---

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

• CTurtle.hpp