sf::Drawable Class Reference

Abstract base class for every object that can be drawn into a render window. More...

#include <Drawable.hpp>

Inheritance diagram for sf::Drawable:

Public Member Functions
	Drawable (const Vector2f &position=Vector2f(0, 0), const Vector2f &scale=Vector2f(1, 1), float rotation=0.f, const Color &color=Color(255, 255, 255))
	Default constructor.
virtual	~Drawable ()
	Virtual destructor.
void	SetPosition (float x, float y)
	Set the position of the object (take 2 values).
void	SetPosition (const Vector2f &position)
	Set the position of the object (take a 2D vector).
void	SetX (float x)
	Set the X position of the object.
void	SetY (float y)
	Set the Y position of the object.
void	SetScale (float factorX, float factorY)
	Set the scale of the object (take 2 values).
void	SetScale (const Vector2f &scale)
	Set the scale of the object (take a 2D vector).
void	SetScaleX (float factor)
	Set the X scale factor of the object.
void	SetScaleY (float factor)
	Set the Y scale factor of the object.
void	SetOrigin (float x, float y)
	Set the local origin of the object, in coordinates relative to the top-left of the object (take 2 values).
void	SetOrigin (const Vector2f &origin)
	Set the local origin of the object, in coordinates relative to the top-left of the object (take a 2D vector).
void	SetRotation (float angle)
	Set the orientation of the object.
void	SetColor (const Color &color)
	Set the color of the object.
void	SetBlendMode (Blend::Mode mode)
	Set the blending mode for the object.
const Vector2f &	GetPosition () const
	Get the position of the object.
const Vector2f &	GetScale () const
	Get the current scale of the object.
const Vector2f &	GetOrigin () const
	Get the local origin of the object.
float	GetRotation () const
	Get the orientation of the object.
const Color &	GetColor () const
	Get the color of the object.
Blend::Mode	GetBlendMode () const
	Get the current blending mode.
void	Move (float offsetX, float offsetY)
	Move the object of a given offset (take 2 values).
void	Move (const Vector2f &offset)
	Move the object of a given offset (take a 2D vector).
void	Scale (float factorX, float factorY)
	Scale the object (take 2 values).
void	Scale (const Vector2f &factor)
	Scale the object (take a 2D vector).
void	Rotate (float Angle)
	Rotate the object.
Vector2f	TransformToLocal (const Vector2f &point) const
	Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's origin, translation, rotation and scale to the point).
Vector2f	TransformToGlobal (const Vector2f &point) const
	Transform a point from local coordinates into global coordinates (ie it applies the object's origin, translation, rotation and scale to the point).
Protected Member Functions
const Matrix3 &	GetMatrix () const
	Get the transform matrix of the drawable.
const Matrix3 &	GetInverseMatrix () const
	Get the inverse transform matrix of the drawable.
Friends
class	RenderTarget

Detailed Description

Abstract base class for every object that can be drawn into a render window.

Definition at line 59 of file Drawable.hpp.

Constructor & Destructor Documentation

sf::Drawable::Drawable	(	const Vector2f &	position = `Vector2f(0, 0)`,
		const Vector2f &	scale = `Vector2f(1, 1)`,
		float	rotation = `0.f`,
		const Color &	color = `Color(255, 255, 255)`
	)

Default constructor.

Parameters:

	position	: Position of the object
	scale	: Scale factor
	rotation	: Orientation, in degrees
	color	: Color of the object

Definition at line 39 of file Drawable.cpp.

sf::Drawable::~Drawable ( ) [virtual]

Virtual destructor.

Definition at line 55 of file Drawable.cpp.

Member Function Documentation

Blend::Mode sf::Drawable::GetBlendMode ( ) const

Get the current blending mode.

Returns:: Current blending mode

Definition at line 263 of file Drawable.cpp.

const Color & sf::Drawable::GetColor ( ) const

Get the color of the object.

Returns:: Current color

Definition at line 254 of file Drawable.cpp.

const Matrix3 & sf::Drawable::GetInverseMatrix ( ) const [protected]

Get the inverse transform matrix of the drawable.

Returns:: Inverse transform matrix

Definition at line 353 of file Drawable.cpp.

const Matrix3 & sf::Drawable::GetMatrix ( ) const [protected]

Get the transform matrix of the drawable.

Returns:: Transform matrix

Definition at line 337 of file Drawable.cpp.

const Vector2f & sf::Drawable::GetOrigin ( ) const

Get the local origin of the object.

Get the origin of the object.

Returns:: Current position of the origin

Definition at line 236 of file Drawable.cpp.

const Vector2f & sf::Drawable::GetPosition ( ) const

Get the position of the object.

Returns:: Current position

Definition at line 218 of file Drawable.cpp.

float sf::Drawable::GetRotation ( ) const

Get the orientation of the object.

Rotation is always in the range [0, 360]

Returns:: Current rotation, in degrees

Definition at line 245 of file Drawable.cpp.

const Vector2f & sf::Drawable::GetScale ( ) const

Get the current scale of the object.

Returns:: Current scale factor (always positive)

Definition at line 227 of file Drawable.cpp.

void sf::Drawable::Move ( const Vector2f & offset )

Move the object of a given offset (take a 2D vector).

Parameters:

offset

: Amount of units to move the object of

Definition at line 282 of file Drawable.cpp.

void sf::Drawable::Move	(	float	offsetX,
		float	offsetY
	)

Move the object of a given offset (take 2 values).

Parameters:

	offsetX	: X offset
	offsetY	: Y offset

Definition at line 273 of file Drawable.cpp.

void sf::Drawable::Rotate ( float Angle )

Rotate the object.

Parameters:

Angle

: Angle of rotation, in degrees

Definition at line 309 of file Drawable.cpp.

void sf::Drawable::Scale ( const Vector2f & factor )

Scale the object (take a 2D vector).

Parameters:

factor

: Scaling factors (both values must be strictly positive)

Definition at line 300 of file Drawable.cpp.

void sf::Drawable::Scale	(	float	factorX,
		float	factorY
	)

Scale the object (take 2 values).

Parameters:

	factorX	: Scaling factor on X (must be strictly positive)
	factorY	: Scaling factor on Y (must be strictly positive)

Definition at line 291 of file Drawable.cpp.

void sf::Drawable::SetBlendMode ( Blend::Mode mode )

Set the blending mode for the object.

The default blend mode is Blend::Alpha

Parameters:

mode

: New blending mode

The default blend mode is Blend::Alpha

Definition at line 209 of file Drawable.cpp.

void sf::Drawable::SetColor ( const Color & color )

Set the color of the object.

The default color is white

Parameters:

color

: New color

The default color is white

Definition at line 199 of file Drawable.cpp.

void sf::Drawable::SetOrigin ( const Vector2f & origin )

Set the local origin of the object, in coordinates relative to the top-left of the object (take a 2D vector).

The default origin is (0, 0)

Parameters:

origin

: New origin

The default origin is (0, 0)

Definition at line 175 of file Drawable.cpp.

void sf::Drawable::SetOrigin	(	float	x,
		float	y
	)

Set the local origin of the object, in coordinates relative to the top-left of the object (take 2 values).

The default origin is (0, 0)

Parameters:

	x	: X coordinate of the origin
	y	: Y coordinate of the origin

The default origin is (0, 0)

Definition at line 160 of file Drawable.cpp.

void sf::Drawable::SetPosition ( const Vector2f & position )

Set the position of the object (take a 2D vector).

Parameters:

position

: New position

Definition at line 74 of file Drawable.cpp.

void sf::Drawable::SetPosition	(	float	x,
		float	y
	)

Set the position of the object (take 2 values).

Parameters:

	x	: New X coordinate
	y	: New Y coordinate

Definition at line 64 of file Drawable.cpp.

void sf::Drawable::SetRotation ( float angle )

Set the orientation of the object.

Parameters:

angle

: Angle of rotation, in degrees

Definition at line 184 of file Drawable.cpp.

void sf::Drawable::SetScale ( const Vector2f & scale )

Set the scale of the object (take a 2D vector).

Parameters:

Scale

: New scale (both values must be strictly positive)

Definition at line 118 of file Drawable.cpp.

void sf::Drawable::SetScale	(	float	factorX,
		float	factorY
	)

Set the scale of the object (take 2 values).

Parameters:

	factorX	: New horizontal scale (must be strictly positive)
	factorY	: New vertical scale (must be strictly positive)

Definition at line 108 of file Drawable.cpp.

void sf::Drawable::SetScaleX ( float factor )

Set the X scale factor of the object.

Parameters:

factor

: New X scale factor

Definition at line 128 of file Drawable.cpp.

void sf::Drawable::SetScaleY ( float factor )

Set the Y scale factor of the object.

Parameters:

factor

: New Y scale factor

Definition at line 143 of file Drawable.cpp.

void sf::Drawable::SetX ( float x )

Set the X position of the object.

Parameters:

x

: New X coordinate

Definition at line 84 of file Drawable.cpp.

void sf::Drawable::SetY ( float y )

Set the Y position of the object.

Parameters:

y

: New Y coordinate

Definition at line 96 of file Drawable.cpp.

Vector2f sf::Drawable::TransformToGlobal ( const Vector2f & point ) const

Transform a point from local coordinates into global coordinates (ie it applies the object's origin, translation, rotation and scale to the point).

Parameters:

point

: Point to transform

Returns:: Transformed point

Definition at line 328 of file Drawable.cpp.

Vector2f sf::Drawable::TransformToLocal ( const Vector2f & point ) const

Transform a point from global coordinates into local coordinates (ie it applies the inverse of object's origin, translation, rotation and scale to the point).

Parameters:

point

: Point to transform

Returns:: Transformed point

Definition at line 319 of file Drawable.cpp.

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

sf::Drawable Class Reference

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation