Inheritance diagram for basic_StackedObject< A_ >:

[legend]

Public Member Functions
	basic_StackedObject (const basic_StackedObjectProvider< A_ > &parent, bool create=true)

	basic_StackedObject (const basic_StackedObjectProvider< A_ > &parent, Gorgon::Animation::ControllerBase &timer)

	basic_StackedObject (RectangularAnimation &top, RectangularAnimation &bottom, const Geometry::Point &offset, bool create=true)
	Creates a stacked object from two animations, these animations should not have controllers attached to them. More...

	basic_StackedObject (RectangularAnimation &top, RectangularAnimation &bottom, const Geometry::Point &offset, Gorgon::Animation::ControllerBase &timer)
	Creates a bottomed object from two animations, these animations should not have controllers attached to them Any attached controllers will be replaced or removed. More...

	~basic_StackedObject ()

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

virtual bool	Progress (unsigned &) 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 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 void	DeleteAnimation () const
	Deletes this animation. 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...

Protected Member Functions
virtual Geometry::Size	calculatesize (const Geometry::Size &area) 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 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...

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

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

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

Constructor & Destructor Documentation

◆ basic_StackedObject() [1/4]

basic_StackedObject	(	const basic_StackedObjectProvider< A_ > &	parent,
		bool	create = `true`
	)

References Base::GetController(), Base::HasController(), and Base::SetController().

◆ basic_StackedObject() [2/4]

basic_StackedObject	(	const basic_StackedObjectProvider< A_ > &	parent,
		Gorgon::Animation::ControllerBase &	timer
	)

References Base::GetController(), Base::HasController(), and Base::SetController().

◆ basic_StackedObject() [3/4]

basic_StackedObject	(	RectangularAnimation &	top,
		RectangularAnimation &	bottom,
		const Geometry::Point &	offset,
		bool	create = `true`
	)

Creates a stacked object from two animations, these animations should not have controllers attached to them.

Any attached controllers will be replaced or removed. A non-const version cannot work as this object needs to control the controllers of these animations.

References Base::GetController(), Base::HasController(), Base::RemoveController(), and Base::SetController().

◆ basic_StackedObject() [4/4]

basic_StackedObject	(	RectangularAnimation &	top,
		RectangularAnimation &	bottom,
		const Geometry::Point &	offset,
		Gorgon::Animation::ControllerBase &	timer
	)

Creates a bottomed object from two animations, these animations should not have controllers attached to them Any attached controllers will be replaced or removed.

A non-const version cannot work as this object needs to control the controllers of these animations.

References Base::GetController(), Base::HasController(), Base::RemoveController(), and Base::SetController().

◆ ~basic_StackedObject()

~basic_StackedObject ( )

References Base::DeleteAnimation().

Member Function Documentation

◆ calculatesize() [1/2]

virtual Geometry::Size calculatesize ( const Geometry::Size & area ) const

overrideprotectedvirtual

This function should return the size of the object when it is requested to be drawn in the given area.

If size contains is a negative value, this function should try to return native size of the object. If no such size exists, a logical size should be returned.

Implements RectangularDrawable.

References RectangularDrawable::CalculateSize(), and Gorgon::Geometry::Union().

◆ calculatesize() [2/2]

virtual Geometry::Size calculatesize	(	const SizeController &	controller,
		const Geometry::Size &	s
	)		const

overrideprotectedvirtual

This function should return the size of the object when it is requested to be drawn in the given area.

This variant should use the given size controller. If the object already has a controller, given controller should be given priority. If h parameter is a negative value, this function should try to return native size of the object. If no such size exists, a logical size should be returned.

Implements RectangularDrawable.

References RectangularDrawable::CalculateSize(), Base::controller, and Gorgon::Geometry::Union().

◆ draw() [1/2]

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

overrideprotectedvirtual

This method should draw to object inside the given quad with the given texture coordinates.

The texture should be considered repeating and any values outside 0-1 range should be treated as such

Implements RectangularDrawable.

◆ draw() [2/2]

void draw	(	TextureTarget &	target,
		const Geometry::Pointf &	p1,
		const Geometry::Pointf &	p2,
		const Geometry::Pointf &	p3,
		const Geometry::Pointf &	p4,
		RGBAf	color
	)		const

overrideprotectedvirtual

This function should draw the object inside the given quad.

The object should be stretched as necessary

Implements RectangularDrawable.

◆ drawin() [1/2]

void drawin	(	TextureTarget &	target,
		const Geometry::Rectanglef &	r,
		RGBAf	color
	)		const

overrideprotectedvirtual

This function should draw the object to the target area.

The object should be tiled or cut to fit the given area It might be logical to override this as it is possible to avoid additional function calls and if statements

Reimplemented from RectangularDrawable.

◆ drawin() [2/2]

void drawin	(	TextureTarget &	target,
		const SizeController &	controller,
		const Geometry::Rectanglef &	r,
		RGBAf	color
	)		const

overrideprotectedvirtual

This function should draw this drawable inside the given rectangle according to the given controller.

If this object already have a size controller, this given controller should be given priority.

Implements RectangularDrawable.

◆ 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.

References Base::GetDuration().

◆ getsize()

Geometry::Size getsize ( ) const

overrideprotectedvirtual

Should return the exact size of this object.

Implements RectangularDrawable.

◆ Progress()

virtual 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/StackedObject.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ basic_StackedObject() [1/4]

◆ basic_StackedObject() [2/4]

◆ basic_StackedObject() [3/4]

◆ basic_StackedObject() [4/4]

◆ ~basic_StackedObject()

Member Function Documentation

◆ calculatesize() [1/2]

◆ calculatesize() [2/2]

◆ draw() [1/2]

◆ draw() [2/2]

◆ drawin() [1/2]

◆ drawin() [2/2]

◆ GetDuration()

◆ getsize()

◆ Progress()