Gorgon Game Engine
Public Member Functions | List of all members
IStackedObjectProvider Class Referenceabstract

For ease of use in resource system. More...

Inheritance diagram for IStackedObjectProvider:
[legend]

Public Member Functions

virtual RectangularAnimation & CreateBottom () const =0
 
virtual RectangularAnimation & CreateTop () const =0
 
virtual Geometry::Point GetOffset () const =0
 
virtual IStackedObjectProvider & MoveOutProvider () override=0
 This function moves this animation provider into a new provider. More...
 
virtual void SetOffset (const Geometry::Point &)=0
 
- Public Member Functions inherited from RectangularAnimationProvider
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
 
- Public Member Functions inherited from AnimationProvider
virtual ~AnimationProvider ()
 
- Public Member Functions inherited from Provider
virtual ~Provider ()
 Virtual destructor. More...
 

Additional Inherited Members

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

Detailed Description

For ease of use in resource system.

Member Function Documentation

◆ CreateBottom()

virtual RectangularAnimation& CreateBottom ( ) const
pure virtual

Implemented in StackedObject.

◆ CreateTop()

virtual RectangularAnimation& CreateTop ( ) const
pure virtual

Implemented in StackedObject.

◆ GetOffset()

virtual Geometry::Point GetOffset ( ) const
pure virtual

Implemented in StackedObject.

◆ MoveOutProvider()

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

Implemented in StackedObject.

◆ SetOffset()

virtual void SetOffset ( const Geometry::Point &  )
pure virtual

Implemented in StackedObject.

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