RectangularAnimationProvider Class Reference

This class provides rectangular animations. More...

Inheritance diagram for RectangularAnimationProvider:

Public Types
using	AnimationType = RectangularAnimation
Public Types inherited from AnimationProvider
using	AnimationType = Animation
Public Types inherited from Provider
using	AnimationType = Base

Public Member Functions
virtual RectangularAnimation &	CreateAnimation (bool create=true) const override=0
	This function should create and animation and depending on the create parameter, it should create its own timer. More...
virtual RectangularAnimation &	CreateAnimation (Gorgon::Animation::ControllerBase &timer) const override=0
	This function should create a new animation with the given controller and if owner parameter is set to true, it should assume ownership of the controller. More...
int	GetHeight () const
virtual Geometry::Size	GetSize () const =0
int	GetWidth () const
virtual RectangularAnimationProvider &	MoveOutProvider () override=0
	This function moves this animation provider into a new provider. More...
Public Member Functions inherited from AnimationProvider
virtual	~AnimationProvider ()
Public Member Functions inherited from Provider
virtual	~Provider ()
	Virtual destructor. More...

Detailed Description

This class provides rectangular animations.

Member Typedef Documentation

AnimationType

using AnimationType = RectangularAnimation

Member Function Documentation

CreateAnimation() [1/2]

virtual RectangularAnimation& CreateAnimation ( bool  create = true ) const

overridepure virtual

This function should create and animation and depending on the create parameter, it should create its own timer.

Implements AnimationProvider.

Implemented in BlankImage, Bitmap, ImageProvider, DiscreteAnimationProvider, TintedObject, StackedObject, ScalableObject, Rectangle, MaskedObject, Line, basic_RectangleProvider< A_ >, basic_LineProvider< A_ >, EmptyImage, and basic_StorageInjection< Graphics::DiscreteAnimationProvider >.

CreateAnimation() [2/2]

virtual RectangularAnimation& CreateAnimation ( Gorgon::Animation::ControllerBase &  timer ) const

overridepure virtual

This function should create a new animation with the given controller and if owner parameter is set to true, it should assume ownership of the controller.

Implements AnimationProvider.

Implemented in DiscreteAnimationProvider, TintedObject, StackedObject, ScalableObject, Rectangle, MaskedObject, Line, basic_RectangleProvider< A_ >, basic_LineProvider< A_ >, EmptyImage, basic_StorageInjection< Graphics::DiscreteAnimationProvider >, BlankImage, Bitmap, and ImageProvider.

GetHeight()

int GetHeight

(

)

const

References RectangularAnimationProvider::GetSize(), and basic_Size< T_ >::Height.

GetSize()

virtual Geometry::Size GetSize ( ) const

pure virtual

Implemented in TintedObject, StackedObject, ScalableObject, Rectangle, MaskedObject, Line, TextureProvider, basic_RectangleProvider< A_ >, basic_LineProvider< A_ >, EmptyImage, BlankImage, Bitmap, and basic_StorageInjection< Graphics::DiscreteAnimationProvider >.

GetWidth()

int GetWidth

(

)

const

References RectangularAnimationProvider::GetSize(), and basic_Size< T_ >::Width.

MoveOutProvider()

virtual RectangularAnimationProvider& MoveOutProvider ( )

overridepure virtual

This function moves this animation provider into a new provider.

Ownership of this new object belongs to the caller and this object could be destroyed safely.

Implements AnimationProvider.

Implemented in ITintedObjectProvider, IStackedObjectProvider, IScalableObjectProvider, IRectangleProvider, IMaskedObjectProvider, ILineProvider, TintedObject, StackedObject, ScalableObject, Rectangle, MaskedObject, Line, EmptyImage, BlankImage, TextureProvider, basic_RectangleProvider< A_ >, basic_LineProvider< A_ >, Bitmap, and basic_StorageInjection< Graphics::DiscreteAnimationProvider >.

---

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

• Gorgon/Graphics/Animations.h