Gorgon Game Engine
DiscreteAnimationProvider Class Referenceabstract

This class provides discrete and rectangular animation which is suitable for bitmap and texture animations. More...

Inheritance diagram for DiscreteAnimationProvider:
[legend]

Public Types

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

Public Member Functions

virtual DiscreteAnimationCreateAnimation (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 DiscreteAnimationCreateAnimation (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...
 
- Public Member Functions inherited from RectangularAnimationProvider
int GetHeight () const
 
virtual Geometry::Size GetSize () const =0
 
int GetWidth () const
 
virtual RectangularAnimationProviderMoveOutProvider () 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...
 
- Public Member Functions inherited from DiscreteProvider
virtual void Add (const Frame &frame)=0
 Adds a frame to the end of the animation. More...
 
virtual void Clear ()=0
 Clears all frames from this animation. More...
 
virtual const FrameFrameAt (int index) const =0
 Returns the frame at specific point. More...
 
virtual int GetCount () const =0
 Returns number of frames. More...
 
virtual unsigned GetDuration () const =0
 Returns the duration of the animation. More...
 
virtual unsigned GetDuration (unsigned frame) const =0
 Returns the duration of the given frame. More...
 
virtual void Insert (const Frame &frame, int before)=0
 Adds a frame to the specified point the animation. More...
 
virtual void MoveBefore (unsigned index, int before)=0
 Moves the frame with the given index to the specified point the animation. More...
 
const Frameoperator[] (int index) const
 Returns the frame at specific point. More...
 
virtual void Remove (unsigned index)=0
 Removes the given frame. More...
 
virtual unsigned StartOf (unsigned frame) const =0
 Returns the starting time of the given frame. More...
 

Detailed Description

This class provides discrete and rectangular animation which is suitable for bitmap and texture animations.

Member Typedef Documentation

◆ AnimationType

Member Function Documentation

◆ CreateAnimation() [1/2]

virtual DiscreteAnimation& 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 RectangularAnimationProvider.

Implemented in basic_StorageInjection< Graphics::DiscreteAnimationProvider >.

◆ CreateAnimation() [2/2]

virtual DiscreteAnimation& 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 RectangularAnimationProvider.

Implemented in basic_StorageInjection< Graphics::DiscreteAnimationProvider >.


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