cturtle::Line Class Reference

The Line class holds two points and the functionality to draw a line between them on a specified canvas. More...

#include <CTurtle.hpp>

Inheritance diagram for cturtle::Line:

Collaboration diagram for cturtle::Line:

Public Member Functions
	Line ()=default
	Empty default constructor.
	Line (Point a, Point b, const Color &color, int width=1)
	Value constructor. merely assigns value of pointA and pointB to respective A and B.
	Line (const Line &other)=default
	Copy constructor. Merely assigns the "to" and "from" points.
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.
	~Line () 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
Point	pointA
Point	pointB
int	width = 1
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 Line class holds two points and the functionality to draw a line between them on a specified canvas.

Constructor & Destructor Documentation

Line() [1/2]

cturtle::Line::Line ( Point a, Point b, const Color & color, int width = 1 )

inline

Value constructor. merely assigns value of pointA and pointB to respective A and B.

Parameters

a	The "From" point.
b	The "To" point.

Line() [2/2]

cturtle::Line::Line ( const Line & other )

default

Copy constructor. Merely assigns the "to" and "from" points.

Parameters

other

The other instance of a line from which to derive value.

Member Function Documentation

copy()

AbstractDrawableObject * cturtle::Line::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::Line::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

pointA

Point cturtle::Line::pointA

The "From" point. Lines drawn with this object start here.

pointB

Point cturtle::Line::pointB

The "To" point. Lines drawn with this object end here.

width

int cturtle::Line::width = 1

The width of the line, in pixels.

---

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

• CTurtle.hpp