#include <ugdk/graphic/modifier.h>

Public Types
enum	Flags { NOTHING = 0, HAS_TRANSFORMATION = 1, HAS_COLOR = 2, TRUNCATES_WHEN_APPLIED = 16 }

Public Member Functions
	Modifier ()
	Creates an identity Modifier;.

	Modifier (const Vector2D &_offset, const Vector2D _scale=Vector2D(1.0, 1.0), double _rotation=0.0, Mirror _mirror=MIRROR_NONE, const Color _color=WHITE, bool _visible=true)
	Creates a new Modifier object with the specified values.

	~Modifier ()

Getters and Setters
const Vector2D &	offset () const

const Vector2D &	scale () const

double	rotation () const

const Mirror &	mirror () const

const Color &	color () const

uint16	flags () const

bool	visible () const

void	set_offset (const Vector2D &_offset)

void	set_scale (const Vector2D &_scale)

void	set_rotation (const double rotation)
	Adjusts rotation to use the [0,2PI] space and sets it to the Modifier.

void	set_mirror (const Mirror mirror)
	Assigns MIRROR_NONE in case of an invalid argument.

void	set_color (const Color &color)
	Truncates each component to [0,1] and sets it to the Modifier.

void	set_visible (const bool _visible)

Static Public Member Functions
static Modifier *	Copy (const Modifier *mod2)
	Remember to free your new Modifier created through this static function!

Component composers.
void	ComposeOffset (const Vector2D &_offset)

void	ComposeScale (const Vector2D &_scale)

void	ToggleFlag (uint16 flag)

void	ComposeRotation (const double rotation)
	Adjusts rotation to use the [0,2PI] space and composes on the Modifier.

void	ComposeMirror (const Mirror &mirror)
	Does nothing if mirror == MIRROR_NONE or if mirror is invalid.

void	ComposeColor (const Color &color)
	Truncates each component to [0,1] and composes on the Modifier.

void	ComposeVisible (bool _visible)

void	ComposeOffset (const Modifier *mod2)

void	ComposeScale (const Modifier *mod2)

void	ComposeRotation (const Modifier *mod2)

void	ComposeMirror (const Modifier *mod2)

void	ComposeColor (const Modifier *mod2)

void	ComposeVisible (const Modifier *mod2)

void	Compose (const Modifier *mod2)
	Global composer and copy from pointer function.

static Modifier *	Compose (const Modifier mod1, const Modifier mod2)
	Remember to free your new Modifier created through this static function!

Member Enumeration Documentation

enum ugdk::graphic::Modifier::Flags

Enumerator:

NOTHING
HAS_TRANSFORMATION
HAS_COLOR
TRUNCATES_WHEN_APPLIED

Constructor & Destructor Documentation

ugdk::graphic::Modifier::Modifier ( )

Creates an identity Modifier;.

ugdk::graphic::Modifier::Modifier	(	const Vector2D &	_offset,
		const Vector2D	_scale = `Vector2D(1.0, 1.0)`,
		double	_rotation = `0.0`,
		Mirror	_mirror = `MIRROR_NONE`,
		const Color	_color = `WHITE`,
		bool	_visible = `true`
	)

inline

Creates a new Modifier object with the specified values.

Parameters

offset	The offset of the image.
size	The size modifiers for the image. X and Y values can be set independently.
rotation	Rotation angle in radians. 0 points to the right, increases in counterclockwise fashion.
mirror	Mirrors the image. Can be MIRROR_NONE for no mirroring, MIRROR_HFLIP for horizontal mirroring or MIRROR_VFLIP for vetical mirroring.
color	The color filter.
alpha	The alpha value for the image.

ugdk::graphic::Modifier::~Modifier ( )

inline

Member Function Documentation

const Color& ugdk::graphic::Modifier::color ( ) const

inline

void ugdk::graphic::Modifier::Compose ( const Modifier * mod2 )

Global composer and copy from pointer function.

Modifier * ugdk::graphic::Modifier::Compose	(	const Modifier *	mod1,
		const Modifier *	mod2
	)

static

Remember to free your new Modifier created through this static function!

void ugdk::graphic::Modifier::ComposeColor ( const Color & color )

Truncates each component to [0,1] and composes on the Modifier.

void ugdk::graphic::Modifier::ComposeColor ( const Modifier * mod2 )

inline

void ugdk::graphic::Modifier::ComposeMirror ( const Mirror & mirror )

Does nothing if mirror == MIRROR_NONE or if mirror is invalid.

void ugdk::graphic::Modifier::ComposeMirror ( const Modifier * mod2 )

inline

void ugdk::graphic::Modifier::ComposeOffset ( const Vector2D & _offset )

inline

void ugdk::graphic::Modifier::ComposeOffset ( const Modifier * mod2 )

inline

void ugdk::graphic::Modifier::ComposeRotation ( const double rotation )

Adjusts rotation to use the [0,2PI] space and composes on the Modifier.

void ugdk::graphic::Modifier::ComposeRotation ( const Modifier * mod2 )

inline

void ugdk::graphic::Modifier::ComposeScale ( const Vector2D & _scale )

inline

void ugdk::graphic::Modifier::ComposeScale ( const Modifier * mod2 )

inline

void ugdk::graphic::Modifier::ComposeVisible ( bool _visible )

inline

void ugdk::graphic::Modifier::ComposeVisible ( const Modifier * mod2 )

inline

Modifier * ugdk::graphic::Modifier::Copy ( const Modifier * mod2 )

static

Remember to free your new Modifier created through this static function!

uint16 ugdk::graphic::Modifier::flags ( ) const

inline

const Mirror& ugdk::graphic::Modifier::mirror ( ) const

inline

const Vector2D& ugdk::graphic::Modifier::offset ( ) const

inline

double ugdk::graphic::Modifier::rotation ( ) const

inline

const Vector2D& ugdk::graphic::Modifier::scale ( ) const

inline

void ugdk::graphic::Modifier::set_color ( const Color & color )

Truncates each component to [0,1] and sets it to the Modifier.

void ugdk::graphic::Modifier::set_mirror ( const Mirror mirror )

Assigns MIRROR_NONE in case of an invalid argument.

void ugdk::graphic::Modifier::set_offset ( const Vector2D & _offset )

inline

void ugdk::graphic::Modifier::set_rotation ( const double rotation )

Adjusts rotation to use the [0,2PI] space and sets it to the Modifier.

void ugdk::graphic::Modifier::set_scale ( const Vector2D & _scale )

inline

void ugdk::graphic::Modifier::set_visible ( const bool _visible )

inline

void ugdk::graphic::Modifier::ToggleFlag ( uint16 flag )

inline

bool ugdk::graphic::Modifier::visible ( ) const

inline

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

src/ugdk/graphic/modifier.h
src/ugdk/graphic/modifier.cc

Public Types

Public Member Functions

Static Public Member Functions

Component composers.

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation