Provider Class Reference

This interface marks a class as animation provider. More...

Inheritance diagram for Provider:

Public Types
using	AnimationType = Base

Public Member Functions
virtual	~Provider ()
	Virtual destructor. More...
virtual Base &	CreateAnimation (bool create=true) const =0
	This function should create an animation and depending on the create parameter, it should create a timer for it. More...
virtual Base &	CreateAnimation (ControllerBase &timer) const =0
	This function should create a new animation with the given controller. More...
virtual Provider &	MoveOutProvider ()=0
	This function moves this animation provider into a new provider. More...

Detailed Description

This interface marks a class as animation provider.

Member Typedef Documentation

AnimationType

using AnimationType = Base

Constructor & Destructor Documentation

~Provider()

virtual ~Provider ( )

virtual

Virtual destructor.

Member Function Documentation

CreateAnimation() [1/2]

virtual Base& CreateAnimation ( bool  create = true ) const

pure virtual

This function should create an animation and depending on the create parameter, it should create a timer for it.

Timer creation is handled by Base class therefore only passing this parameter to the constructor is enough.

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

CreateAnimation() [2/2]

virtual Base& CreateAnimation ( ControllerBase &  timer ) const

pure virtual

This function should create a new animation with the given controller.

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

MoveOutProvider()

virtual Provider& MoveOutProvider ( )

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

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

---

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

• Gorgon/Animation.h