Inheritance diagram for basic_TextureAnimation< T_, P_, F_ >:

[legend]

Public Types
using	FrameType = F_

using	ParentType = P_

Public Member Functions
	basic_TextureAnimation (const ParentType &parent, bool create)
	Creates a new image animation from the given parent. More...

	basic_TextureAnimation (const ParentType &parent, Gorgon::Animation::ControllerBase &controller)
	Creates a new image animation from the given parent. More...

unsigned	CurrentFrame () const override
	Returns the current frame. More...

virtual void	DeleteAnimation () const override
	Deletes this animation object. More...

virtual const Geometry::Pointf *	GetCoordinates () const override
	Should return the coordinates of the texture to be used. More...

int	GetDuration () const override
	Returns the duration of the animation if it is a known apriori. More...

virtual GL::Texture	GetID () const override
	Should return GL::Texture to be drawn. This could be 0 to denote no texture is to be used. More...

virtual Geometry::Size	GetImageSize () const override
	Should return the size of the image stored in texture. Not the whole texture size. More...

virtual ColorMode	GetMode () const override

virtual bool	Progress (unsigned &leftover) override
	This function should progress the animation. More...

Public Member Functions inherited from RectangularDrawable
const Geometry::Size	CalculateSize (const Geometry::Size &area) const
	Calculates the adjusted size of this drawable depending on the given area. More...

const Geometry::Size	CalculateSize (const SizeController &controller, const Geometry::Size &area) const
	Calculates the adjusted size of this drawable depending on the given area and controller. More...

const Geometry::Size	CalculateSize (const SizeController &controller, int w=-1, int h=-1) const
	Calculates the adjusted size of this drawable depending on the given area and controller. More...

const Geometry::Size	CalculateSize (int w=-1, int h=-1) const
	Calculates the adjusted size of this drawable depending on the given area. More...

void	Draw (TextureTarget &target, const Geometry::Point &p, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates. More...

void	Draw (TextureTarget &target, const Geometry::Pointf &p, const Geometry::Sizef &size, const Geometry::Pointf &t1, const Geometry::Pointf &t2, const Geometry::Pointf &t3, const Geometry::Pointf &t4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, const Geometry::Pointf &p, const Geometry::Sizef &size, float u1, float v1, float u2, float v2, float u3, float v3, float u4, float v4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, const Geometry::Pointf &p, float w, float h, const Geometry::Pointf &t1, const Geometry::Pointf &t2, const Geometry::Pointf &t3, const Geometry::Pointf &t4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, const Geometry::Pointf &p, float w, float h, float u1, float v1, float u2, float v2, float u3, float v3, float u4, float v4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, const Geometry::Pointf &p, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates. More...

void	Draw (TextureTarget &target, const Geometry::Pointf &p1, const Geometry::Pointf &p2, const Geometry::Pointf &p3, const Geometry::Pointf &p4, const Geometry::Pointf &t1, const Geometry::Pointf &t2, const Geometry::Pointf &t3, const Geometry::Pointf &t4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, const Geometry::Pointf &p1, const Geometry::Pointf &p2, const Geometry::Pointf &p3, const Geometry::Pointf &p4, float u1, float v1, float u2, float v2, float u3, float v3, float u4, float v4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, const Geometry::Pointf &p1, const Geometry::Pointf &p2, const Geometry::Pointf &p3, const Geometry::Pointf &p4, RGBAf color=RGBAf(1.f)) const
	Draw the object to the target by specifying coordinates for four corners. More...

void	Draw (TextureTarget &target, float x, float y, const Geometry::Sizef &size, const Geometry::Pointf &t1, const Geometry::Pointf &t2, const Geometry::Pointf &t3, const Geometry::Pointf &t4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, float x, float y, const Geometry::Sizef &size, float u1, float v1, float u2, float v2, float u3, float v3, float u4, float v4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, float x, float y, float w, float h, const Geometry::Pointf &t1, const Geometry::Pointf &t2, const Geometry::Pointf &t3, const Geometry::Pointf &t4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, float x, float y, float w, float h, float u1, float v1, float u2, float v2, float u3, float v3, float u4, float v4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, float x, float y, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates. More...

void	Draw (TextureTarget &target, float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4, const Geometry::Pointf &t1, const Geometry::Pointf &t2, const Geometry::Pointf &t3, const Geometry::Pointf &t4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4, float u1, float v1, float u2, float v2, float u3, float v3, float u4, float v4, RGBAf color=RGBAf(1.f)) const
	Draws the object with the given screen and texture coordinates. More...

void	Draw (TextureTarget &target, float x1, float y1, float x2, float y2, float x3, float y3, float x4, float y4, RGBAf color=RGBAf(1.f)) const
	Draw the object to the target by specifying coordinates for four corners. More...

void	Draw (TextureTarget &target, int x, int y, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates. More...

void	DrawIn (TextureTarget &target, const Geometry::Point &p, const Geometry::Size &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area. More...

void	DrawIn (TextureTarget &target, const Geometry::Point &p, int w, int h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area. More...

void	DrawIn (TextureTarget &target, const Geometry::Pointf &p, const Geometry::Sizef &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area. More...

void	DrawIn (TextureTarget &target, const Geometry::Pointf &p, float w, float h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area. More...

void	DrawIn (TextureTarget &target, const Geometry::Rectangle &r, RGBAf color=RGBAf(1.f)) const
	Draw in the given area. More...

void	DrawIn (TextureTarget &target, const Geometry::Rectanglef &r, RGBAf color=RGBAf(1.f)) const
	Draw in the given area. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, const Geometry::Point &p, const Geometry::Size &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area with the given size according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, const Geometry::Point &p, int w, int h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, const Geometry::Pointf &p, const Geometry::Sizef &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area with the given size according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, const Geometry::Pointf &p, float w, float h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, const Geometry::Rectangle &r, RGBAf color=RGBAf(1.f)) const
	Draw in the given area according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, const Geometry::Rectanglef &r, RGBAf color=RGBAf(1.f)) const
	Draw in the given area according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, float x, float y, const Geometry::Sizef &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area the given size according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, float x, float y, float w, float h, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates with the given size according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, int x, int y, const Geometry::Size &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area the given size according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, int x, int y, int w, int h, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates with the given size according to the given controller. More...

void	DrawIn (TextureTarget &target, const SizeController &controller, RGBAf color=RGBAf(1.f)) const
	Draw to fill the given target according to the given controller. More...

void	DrawIn (TextureTarget &target, float x, float y, const Geometry::Sizef &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area. More...

void	DrawIn (TextureTarget &target, float x, float y, float w, float h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area. More...

void	DrawIn (TextureTarget &target, int x, int y, const Geometry::Size &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area. More...

void	DrawIn (TextureTarget &target, int x, int y, int w, int h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area. More...

void	DrawIn (TextureTarget &target, RGBAf color=RGBAf(1.f)) const
	Draw to fill the given target. More...

void	DrawIn (TextureTarget &target, Tiling tiling, const Geometry::Point &p, const Geometry::Size &size, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawIn (TextureTarget &target, Tiling tiling, const Geometry::Point &p, int w, int h, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawIn (TextureTarget &target, Tiling tiling, const Geometry::Pointf &p, const Geometry::Sizef &size, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawIn (TextureTarget &target, Tiling tiling, const Geometry::Pointf &p, float w, float h, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawIn (TextureTarget &target, Tiling tiling, const Geometry::Rectangle &r, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawIn (TextureTarget &target, Tiling tiling, const Geometry::Rectanglef &r, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawIn (TextureTarget &target, Tiling tiling, float x, float y, const Geometry::Sizef &size, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawIn (TextureTarget &target, Tiling tiling, float x, float y, float w, float h, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawIn (TextureTarget &target, Tiling tiling, int x, int y, const Geometry::Size &size, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawIn (TextureTarget &target, Tiling tiling, int x, int y, int w, int h, RGBAf color=RGBAf(1.f)) const
	Draws the object to the target using the given tiling information. More...

void	DrawRotated (TextureTarget &target, const Geometry::Point &p, float angle, const Geometry::Pointf &origin=Geometry::Point(0, 0), RGBAf color=RGBAf(1.f)) const
	Draw the object rotated to the given angle in radians, full C++11 support will enable the use of 90deg like qualifiers. More...

void	DrawRotated (TextureTarget &target, const Geometry::Point &p, float angle, RGBAf color) const
	Draw the object rotated to the given angle in radians, full C++11 support will enable the use of 90deg like qualifiers. More...

void	DrawRotated (TextureTarget &target, int x, int y, float angle, float oX, float oY, RGBAf color=RGBAf(1.f)) const
	Draw the object rotated to the given angle in radians, full C++11 support will enable the use of 90deg like qualifiers. More...

void	DrawStretched (TextureTarget &target, const Geometry::Point &p, const Geometry::Size &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

void	DrawStretched (TextureTarget &target, const Geometry::Point &p, int w, int h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

void	DrawStretched (TextureTarget &target, const Geometry::Pointf &p, const Geometry::Sizef &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

void	DrawStretched (TextureTarget &target, const Geometry::Pointf &p, float w, float h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

void	DrawStretched (TextureTarget &target, const Geometry::Rectangle &r, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

void	DrawStretched (TextureTarget &target, const Geometry::Rectanglef &r, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

void	DrawStretched (TextureTarget &target, float x, float y, const Geometry::Sizef &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

void	DrawStretched (TextureTarget &target, float x, float y, float w, float h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

void	DrawStretched (TextureTarget &target, int x, int y, const Geometry::Size &size, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

void	DrawStretched (TextureTarget &target, int x, int y, int w, int h, RGBAf color=RGBAf(1.f)) const
	Draw to the given area by stretching object to fit. More...

int	GetHeight () const
	Returns the height of the drawable. More...

const Geometry::Size	GetSize () const
	Returns the size of this object. More...

int	GetWidth () const
	Returns the width of the drawable. More...

Public Member Functions inherited from Drawable
virtual	~Drawable ()

void	Draw (TextureTarget &target, const Geometry::Point &p, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates. More...

void	Draw (TextureTarget &target, const Geometry::Pointf &p, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates. More...

void	Draw (TextureTarget &target, float x, float y, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates. More...

void	Draw (TextureTarget &target, int x, int y, RGBAf color=RGBAf(1.f)) const
	Draw to the given coordinates. More...

Public Member Functions inherited from TextureSource
bool	IsPartial () const
	Returns whether this texture uses only a part of the GL::Texture. More...

Public Member Functions inherited from Base
	Base (bool create=false)
	This constructor creates a new controller depending on the create parameter. More...

	Base (const Base &base)
	Copies the animation. More...

	Base (ControllerBase &controller)
	Sets the controller for this animation to the given controller. More...

virtual ControllerBase &	GetController () const
	Returns the controller of this animation. More...

virtual bool	HasController () const
	Returns whether this animation has a controller. More...

virtual void	RemoveController ()
	Removes the controller of this animation. More...

virtual void	SetController (ControllerBase &controller)
	Sets the controller to the given controller. More...

Additional Inherited Members
Static Public Attributes inherited from DiscreteAnimation
static const unsigned	NoFrame
	This variable denotes that this animation has no frame at the moment. More...

Protected Member Functions inherited from Image
virtual Geometry::Size	calculatesize (const Geometry::Size &s) const override
	This function should return the size of the object when it is requested to be drawn in the given area. More...

virtual Geometry::Size	calculatesize (const SizeController &controller, const Geometry::Size &s) const override
	This function should return the size of the object when it is requested to be drawn in the given area. More...

virtual void	draw (TextureTarget &target, const Geometry::Pointf &p1, const Geometry::Pointf &p2, const Geometry::Pointf &p3, const Geometry::Pointf &p4, const Geometry::Pointf &tex1, const Geometry::Pointf &tex2, const Geometry::Pointf &tex3, const Geometry::Pointf &tex4, RGBAf color) const override
	This method should draw to object inside the given quad with the given texture coordinates. More...

virtual void	draw (TextureTarget &target, const Geometry::Pointf &p1, const Geometry::Pointf &p2, const Geometry::Pointf &p3, const Geometry::Pointf &p4, RGBAf color) const override
	This function should draw the object inside the given quad. More...

virtual void	drawin (TextureTarget &target, const Geometry::Rectanglef &r, RGBAf color) const override
	This function should draw the object to the target area. More...

virtual void	drawin (TextureTarget &target, const SizeController &controller, const Geometry::Rectanglef &r, RGBAf color) const override
	This function should draw this drawable inside the given rectangle according to the given controller. More...

virtual void	drawstretched (TextureTarget &target, const Geometry::Rectanglef &r, RGBAf color) const override
	This function should draw the object to the target area. More...

virtual Geometry::Size	getsize () const override
	Should return the exact size of this object. More...

Protected Member Functions inherited from RectangularDrawable
virtual void	draw (TextureTarget &target, const Geometry::Pointf &p, RGBAf color) const override
	This function should draw the object to the given point. More...

Protected Member Functions inherited from Base
virtual	~Base ()
	Virtual destructor. More...

Protected Attributes inherited from Base
ControllerBase *	controller
	Controller of this animation. More...

Static Protected Attributes inherited from TextureSource
static const Geometry::Pointf	fullcoordinates [4]
	Coordinates that selects the entire texture to be used. More...

Member Typedef Documentation

◆ FrameType

using FrameType = F_

◆ ParentType

using ParentType = P_

Constructor & Destructor Documentation

◆ basic_TextureAnimation() [1/2]

basic_TextureAnimation	(	const ParentType &	parent,
		Gorgon::Animation::ControllerBase &	controller
	)

Creates a new image animation from the given parent.

◆ basic_TextureAnimation() [2/2]

basic_TextureAnimation	(	const ParentType &	parent,
		bool	create
	)

Creates a new image animation from the given parent.

Member Function Documentation

◆ CurrentFrame()

unsigned CurrentFrame ( ) const

overridevirtual

Returns the current frame.

This function might return NoFrame to denote that the animation does not contain a frame.

Implements DiscreteAnimation.

◆ DeleteAnimation()

virtual void DeleteAnimation ( ) const

overridevirtual

Deletes this animation object.

Reimplemented from Base.

◆ GetCoordinates()

virtual const Geometry::Pointf* GetCoordinates ( ) const

overridevirtual

Should return the coordinates of the texture to be used.

Implements TextureSource.

References Gorgon::Utils::ASSERT_FALSE().

◆ GetDuration()

int GetDuration ( ) const

overridevirtual

Returns the duration of the animation if it is a known apriori.

If the animation can be progressed infinitely, if it is possible to derive optimal duration, it should be returned. In case when it is impossible to determine the duration, return 0.

Implements Base.

◆ GetID()

virtual GL::Texture GetID ( ) const

overridevirtual

Should return GL::Texture to be drawn. This could be 0 to denote no texture is to be used.

Implements TextureSource.

References Gorgon::Utils::ASSERT_FALSE().

◆ GetImageSize()

virtual Geometry::Size GetImageSize ( ) const

overridevirtual

Should return the size of the image stored in texture. Not the whole texture size.

Implements TextureSource.

References Gorgon::Utils::ASSERT_FALSE().

◆ GetMode()

virtual ColorMode GetMode ( ) const

overridevirtual

Implements TextureSource.

References Gorgon::Utils::ASSERT_FALSE(), and Gorgon::Graphics::RGBA.

◆ Progress()

bool Progress ( unsigned & leftover )

overridevirtual

This function should progress the animation.

Notice that this function is called internally. Unless a change to the controller has been made and instant update of the animation is required there is no need to call this function. Returning true from this function denotes that the further progress is possible. If progress should end, leftover parameter should be set to the amount of time that cannot be progressed. Progress function should also mind uncontrollable controllers.

Implements Base.

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

Gorgon/Graphics/TextureAnimation.h

Public Types

Public Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ FrameType

◆ ParentType

Constructor & Destructor Documentation

◆ basic_TextureAnimation() [1/2]

◆ basic_TextureAnimation() [2/2]

Member Function Documentation

◆ CurrentFrame()

◆ DeleteAnimation()

◆ GetCoordinates()

◆ GetDuration()

◆ GetID()

◆ GetImageSize()

◆ GetMode()

◆ Progress()