The Transform class provides a myriad of functions to simply transform points. This class it the backbone of almost all cartesian plane math in CTurtle. An adapted 3x3 matrix of the following link: http://www.opengl-tutorial.org/beginners-tutorials/tutorial-3-matrices/. More...

#include <CTurtle.hpp>

Public Member Functions
	Transform ()

	Transform (const Transform &other)=default
	Copy constructor.

	Transform (const ivec2 &point, float rotation)
	Point and rotation constructor. Initializes a transform with the specified rotation, a translation matching the specified point.

Transform &	identity ()
	Sets this transform to an identity. When you concatenate an identity transform onto another object, The resulting point is the same as it would have been pre-concatenation. Such is the point of an identity transform, and is why Transforms are initialized to have this value.

bool	operator== (const Transform &other) const
	Returns a boolean indicating if this transform is equivalent in value to the one specified.

float	getScaleX () const
	Returns the X scale of this transform.

float	getScaleY () const
	Returns the Y scale of this transform.

float	getTranslateX () const
	Returns the X translation of this transform.

float	getTranslateY () const
	Returns the Y translation of this transform.

float	getRotation () const
	Returns rotation of this transform, in radians.

Transform &	forward (float distance)

Transform &	backward (float distance)

Transform &	setTranslation (int x, int y)
	Sets the translation of this transform.

Point	getTranslation () const
	Returns the translation of this transform as a point.

Transform &	setTranslationX (int x)
	Sets the X axis translation of this transform.

Transform &	setTranslationY (int y)
	Set the Y axis translation of this transform.

Transform &	translate (int x, int y)
	Translates this transform.

Transform &	rotate (float theta)
	Rotates this transform.

Transform &	setRotation (float val)
	Sets the rotation of this transform.

Transform &	rotateAround (int x, int y, float theta)
	Rotates this transform around a specified point.

Transform &	scale (float sx, float sy)
	Applies a scale transformation to this transform.

Transform &	concatenate (const Transform &t)
	Concatenates this Transform with another.

Transform	copyConcatenate (const Transform &t) const
	Creates a copy of this transform, concatenates the input, and returns it.

Transform	lerp (const Transform &t, float progress) const
	Interpolates between this and the specified transform. Progress is a float in range of 0 to 1.

void	assign (const Transform &t)
	Assigns the value of this transform to that of another.

Point	transform (Point in, Point *dst=nullptr) const
	Transforms a point according to this transform.

template<typename ITER_T >
void	transformSet (ITER_T cur, ITER_T end) const
	Transforms a set of points given a begin and end iterator.

Point	operator() (Point in) const
	Operator overload to transform a single point.

Protected Types
typedef std::array< float, 9 >	mat_t

Protected Member Functions
float &	at (int row, int col)
	Returns a reference to the float the specified coordinate.

float	at (int row, int col) const
	Returns a copy of the float at the specified coordinate.

Protected Attributes
mat_t	value

float	rotation = 0

Detailed Description

The Transform class provides a myriad of functions to simply transform points. This class it the backbone of almost all cartesian plane math in CTurtle. An adapted 3x3 matrix of the following link: http://www.opengl-tutorial.org/beginners-tutorials/tutorial-3-matrices/.

Member Typedef Documentation

◆ mat_t

typedef std::array<float, 9> cturtle::Transform::mat_t

protected

The underlying matrix type. It's defined simply as an array of 9 floats. Retrieved from coordinate pairs using (x*3+y) as indices.

Constructor & Destructor Documentation

◆ Transform() [1/3]

cturtle::Transform::Transform ( )

inline

Constructs an empty transform. Initializes, by default, as an identity transform.

◆ Transform() [2/3]

cturtle::Transform::Transform ( const Transform & other )

default

Copy constructor.

Parameters

other The other transform from which to derive value.

◆ Transform() [3/3]

cturtle::Transform::Transform	(	const ivec2 &	point,
		float	rotation )

inline

Point and rotation constructor. Initializes a transform with the specified rotation, a translation matching the specified point.

Parameters

point	The translation of this newly constructed transform.
rotation	The rotation of this newly constructed transform.

Member Function Documentation

◆ assign()

void cturtle::Transform::assign ( const Transform & t )

inline

Assigns the value of this transform to that of another.

Parameters

t	The other transform to derive value from.

◆ at() [1/2]

float & cturtle::Transform::at	(	int	row,
		int	col )

inlineprotected

Returns a reference to the float the specified coordinate.

Parameters

row	The specified row from which to get a component.
col	The specified column from which to get a component.

◆ at() [2/2]

float cturtle::Transform::at	(	int	row,
		int	col ) const

inlineprotected

Returns a copy of the float at the specified coordinate.

Parameters

row	The specified row from which to get a component.
col	The specified column from which to get a component.

◆ concatenate()

Transform & cturtle::Transform::concatenate ( const Transform & t )

inline

Concatenates this Transform with another.

Parameters

t	The other Transform to concatenate with.

Returns: A reference to this transform. (e.g, *this)

◆ copyConcatenate()

Transform cturtle::Transform::copyConcatenate ( const Transform & t ) const

inline

Creates a copy of this transform, concatenates the input, and returns it.

Parameters

t	The input to concatenate onto the copy of this transform.

Returns: Returns the concatenated copy of this transform.

◆ forward()

Transform & cturtle::Transform::forward ( float distance )

inline

Moves this transform "forward" according to its rotation.

◆ getRotation()

float cturtle::Transform::getRotation ( ) const

inline

Returns rotation of this transform, in radians.

Returns: The rotation of this transform, in radians.

◆ getScaleX()

float cturtle::Transform::getScaleX ( ) const

inline

Returns the X scale of this transform.

Returns: Returns the X scale of this transform.

◆ getScaleY()

float cturtle::Transform::getScaleY ( ) const

inline

Returns the Y scale of this transform.

Returns: Returns the Y scale of this transform.

◆ getTranslateX()

float cturtle::Transform::getTranslateX ( ) const

inline

Returns the X translation of this transform.

Returns: Returns the X translation of this transform.

◆ getTranslateY()

float cturtle::Transform::getTranslateY ( ) const

inline

Returns the Y translation of this transform.

Returns: Returns the Y translation of this transform.

◆ getTranslation()

Point cturtle::Transform::getTranslation ( ) const

inline

Returns the translation of this transform as a point.

Returns: The point which represents the transform.

◆ identity()

Transform & cturtle::Transform::identity ( )

inline

Sets this transform to an identity. When you concatenate an identity transform onto another object, The resulting point is the same as it would have been pre-concatenation. Such is the point of an identity transform, and is why Transforms are initialized to have this value.

Returns: A reference to this transform. (e.g, *this)

◆ lerp()

Transform cturtle::Transform::lerp	(	const Transform &	t,
		float	progress ) const

inline

Interpolates between this and the specified transform. Progress is a float in range of 0 to 1.

Parameters

t	The destination transform.
progress	A progress float in range of 0 to 1.

Returns: The resulting interpolated transform.

◆ operator()()

Point cturtle::Transform::operator() ( Point in ) const

inline

Operator overload to transform a single point.

Parameters

in	The point to transform.

◆ rotate()

Transform & cturtle::Transform::rotate ( float theta )

inline

Rotates this transform.

Parameters

theta The angle at which to rotate, in radians

Returns: A reference to this transform. (e.g, *this)

◆ rotateAround()

Transform & cturtle::Transform::rotateAround	(	int	x,
		int	y,
		float	theta )

inline

Rotates this transform around a specified point.

Parameters

x	The X coordinate to rotate around.
y	The Y coordinate to rotate around.
theta	The angle at which to rotate, in radians

Returns: A reference to this transform. (e.g, *this)

◆ scale()

Transform & cturtle::Transform::scale	(	float	sx,
		float	sy )

inline

Applies a scale transformation to this transform.

Parameters

sx	The X axis scale factor.
sy	The Y axis scale factor.

◆ setRotation()

Transform & cturtle::Transform::setRotation ( float val )

inline

Sets the rotation of this transform.

Parameters

val	The angle at which to rotate, in radians.

Returns: A reference to this transform. (e.g, *this)

◆ setTranslation()

Transform & cturtle::Transform::setTranslation	(	int	x,
		int	y )

inline

Sets the translation of this transform.

Parameters

x	The number of units, or pixels, to transform on the X axis.
y	The number of units, or pixels, to transform on the Y axis.

Returns: A reference to this transform. (e.g, *this)

◆ setTranslationX()

Transform & cturtle::Transform::setTranslationX ( int x )

inline

Sets the X axis translation of this transform.

Parameters

x	The number of units, or pixels, to transform on the X axis.

Returns: A reference to this transform. (e.g, *this)

◆ setTranslationY()

Transform & cturtle::Transform::setTranslationY ( int y )

inline

Set the Y axis translation of this transform.

Parameters

y	The number of units, or pixels, to transform on the Y axis.

Returns: A reference to this transform. (e.g, *this)

◆ transform()

Point cturtle::Transform::transform	(	Point	in,
		Point *	dst = nullptr ) const

inline

Transforms a point according to this transform.

Parameters

in	The input point.
dst	The destination pointer to store the value. Can be same as input..

Returns: Returns the translated point.; Also assigns the value of dst pointer to the result.

◆ transformSet()

template<typename ITER_T >

void cturtle::Transform::transformSet	(	ITER_T	cur,
		ITER_T	end ) const

inline

Transforms a set of points given a begin and end iterator.

Parameters

cur	The beginning iterator of a set.
end	The ending iterator of a set.

◆ translate()

Transform & cturtle::Transform::translate	(	int	x,
		int	y )

inline

Translates this transform.

Parameters

x	The number of units, or pixels, to transform on the X axis.
y	The number of units, or pixels, to transform on the Y axis.

Returns: A reference to this transform. (e.g, *this)

Member Data Documentation

◆ rotation

float cturtle::Transform::rotation = 0

protected

The rotation of this transform, in radians.

◆ value

mat_t cturtle::Transform::value

protected

The value of this transform.

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

CTurtle.hpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ mat_t

Constructor & Destructor Documentation

◆ Transform() [1/3]

◆ Transform() [2/3]

◆ Transform() [3/3]

Member Function Documentation

◆ assign()

◆ at() [1/2]

◆ at() [2/2]

◆ concatenate()

◆ copyConcatenate()

◆ forward()

◆ getRotation()

◆ getScaleX()

◆ getScaleY()

◆ getTranslateX()

◆ getTranslateY()

◆ getTranslation()

◆ identity()

◆ lerp()

◆ operator()()

◆ rotate()

◆ rotateAround()

◆ scale()

◆ setRotation()

◆ setTranslation()

◆ setTranslationX()

◆ setTranslationY()

◆ transform()

◆ transformSet()

◆ translate()

Member Data Documentation

◆ rotation

◆ value