cturtle::Circle Class Reference

The Circle class holds a radius and total number of steps, used to generate and draw a circles geometry. More...

#include <CTurtle.hpp>

Inheritance diagram for cturtle::Circle:

Collaboration diagram for cturtle::Circle:

Public Member Functions
	Circle ()=default
	Empty constructor.
	Circle (int radius, int steps, const Color &fillColor, int outlineWidth=0, const Color &outlineColor=Color())
	Radius and step assignment constructor.
	Circle (const Circle &other)=default
	Copy constructor.
AbstractDrawableObject *	copy () const override
	Returns a pointer to a copy of this drawable object, allocated with NEW. Result must be deleted at the responsibility of the invoker.
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
int	radius = 10
int	steps = 10
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 Circle class holds a radius and total number of steps, used to generate and draw a circles geometry.

Constructor & Destructor Documentation

Circle() [1/2]

cturtle::Circle::Circle ( int radius, int steps, const Color & fillColor, int outlineWidth = 0, const Color & outlineColor = Color() )

inline

Radius and step assignment constructor.

Parameters

radius	The radius, in pixels, of this circle.
steps	The number of vertices used by this circle.

Circle() [2/2]

cturtle::Circle::Circle ( const Circle & other )

default

Copy constructor.

Parameters

other

Another instance of a circle from which to derive value.

Member Function Documentation

copy()

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

inlineoverridevirtual

Returns a pointer to a copy of this drawable object, allocated with NEW. Result must be deleted at the responsibility of the invoker.

Implements cturtle::AbstractDrawableObject.

draw()

void cturtle::Circle::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.

Member Data Documentation

radius

int cturtle::Circle::radius = 10

Radius, in pixels, of the geometry generated in the draw function.

steps

int cturtle::Circle::steps = 10

Total number of steps, or vertices, generated in the draw function. The higher this number is, the more "high-quality" it can be considered.

---

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

• CTurtle.hpp