Gorgon Game Engine
AnimationProvider Class Referenceabstract

A regular drawable animation provider. More...

Inheritance diagram for AnimationProvider:
[legend]

Public Types

using AnimationType = Animation
 
- Public Types inherited from Provider
using AnimationType = Base
 

Public Member Functions

virtual ~AnimationProvider ()
 
virtual AnimationCreateAnimation (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 AnimationCreateAnimation (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...
 
virtual AnimationProviderMoveOutProvider () override=0
 This function moves this animation provider into a new provider. More...
 
- Public Member Functions inherited from Provider
virtual ~Provider ()
 Virtual destructor. More...
 

Detailed Description

A regular drawable animation provider.

Member Typedef Documentation

◆ AnimationType

Constructor & Destructor Documentation

◆ ~AnimationProvider()

virtual ~AnimationProvider ( )
virtual

Member Function Documentation

◆ CreateAnimation() [1/2]

virtual Animation& CreateAnimation ( bool  create = true) const
overridepure virtual

◆ CreateAnimation() [2/2]

virtual Animation& 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 Provider.

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

◆ MoveOutProvider()

virtual AnimationProvider& 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 using DeleteAnimation.

Implements Provider.

Implemented in ITintedObjectProvider, IStackedObjectProvider, IScalableObjectProvider, IRectangleProvider, IMaskedObjectProvider, ILineProvider, RectangularAnimationProvider, 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: