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

Interface for RectangleProviders. More...

Inheritance diagram for IRectangleProvider:
[legend]

Public Member Functions

 IRectangleProvider ()
 
virtual RectangularAnimation & CreateBL () const =0
 Creates an animation without controller. This function should always return an animation. More...
 
virtual RectangularAnimation & CreateBM () const =0
 Creates an animation without controller. This function should always return an animation. More...
 
virtual RectangularAnimation & CreateBR () const =0
 Creates an animation without controller. This function should always return an animation. More...
 
virtual RectangularAnimation & CreateML () const =0
 Creates an animation without controller. This function should always return an animation. More...
 
virtual RectangularAnimation & CreateMM () const =0
 Creates an animation without controller. This function should always return an animation. More...
 
virtual RectangularAnimation & CreateMR () const =0
 Creates an animation without controller. This function should always return an animation. More...
 
virtual RectangularAnimation & CreateTL () const =0
 Creates an animation without controller. This function should always return an animation. More...
 
virtual RectangularAnimation & CreateTM () const =0
 Creates an animation without controller. This function should always return an animation. More...
 
virtual RectangularAnimation & CreateTR () const =0
 Creates an animation without controller. This function should always return an animation. More...
 
virtual bool GetCenterTiling () const
 Returns if the middle part will be tiled. More...
 
virtual bool GetSideTiling () const
 Returns if the middle part will be tiled. More...
 
virtual IRectangleProvider & MoveOutProvider () override=0
 This function moves this animation provider into a new provider. More...
 
virtual void SetCenterTiling (bool value)
 Sets whether the middle part would be tiled. More...
 
virtual void SetSideTiling (bool value)
 Sets whether the side parts (tm, ml, mr, bm) would be tiled. More...
 
- 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

Interface for RectangleProviders.

Constructor & Destructor Documentation

◆ IRectangleProvider()

IRectangleProvider ( )

Member Function Documentation

◆ CreateBL()

virtual RectangularAnimation& CreateBL ( ) const
pure virtual

Creates an animation without controller. This function should always return an animation.

Implemented in Rectangle, and basic_RectangleProvider< A_ >.

◆ CreateBM()

virtual RectangularAnimation& CreateBM ( ) const
pure virtual

Creates an animation without controller. This function should always return an animation.

Implemented in Rectangle, and basic_RectangleProvider< A_ >.

◆ CreateBR()

virtual RectangularAnimation& CreateBR ( ) const
pure virtual

Creates an animation without controller. This function should always return an animation.

Implemented in Rectangle, and basic_RectangleProvider< A_ >.

◆ CreateML()

virtual RectangularAnimation& CreateML ( ) const
pure virtual

Creates an animation without controller. This function should always return an animation.

Implemented in Rectangle, and basic_RectangleProvider< A_ >.

◆ CreateMM()

virtual RectangularAnimation& CreateMM ( ) const
pure virtual

Creates an animation without controller. This function should always return an animation.

Implemented in Rectangle, and basic_RectangleProvider< A_ >.

◆ CreateMR()

virtual RectangularAnimation& CreateMR ( ) const
pure virtual

Creates an animation without controller. This function should always return an animation.

Implemented in Rectangle, and basic_RectangleProvider< A_ >.

◆ CreateTL()

virtual RectangularAnimation& CreateTL ( ) const
pure virtual

Creates an animation without controller. This function should always return an animation.

Implemented in Rectangle, and basic_RectangleProvider< A_ >.

◆ CreateTM()

virtual RectangularAnimation& CreateTM ( ) const
pure virtual

Creates an animation without controller. This function should always return an animation.

Implemented in Rectangle, and basic_RectangleProvider< A_ >.

◆ CreateTR()

virtual RectangularAnimation& CreateTR ( ) const
pure virtual

Creates an animation without controller. This function should always return an animation.

Implemented in Rectangle, and basic_RectangleProvider< A_ >.

◆ GetCenterTiling()

virtual bool GetCenterTiling ( ) const
virtual

Returns if the middle part will be tiled.

Reimplemented in Rectangle.

◆ GetSideTiling()

virtual bool GetSideTiling ( ) const
virtual

Returns if the middle part will be tiled.

Reimplemented in Rectangle.

◆ MoveOutProvider()

virtual IRectangleProvider& 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 Rectangle, and basic_RectangleProvider< A_ >.

◆ SetCenterTiling()

virtual void SetCenterTiling ( bool  value)
virtual

Sets whether the middle part would be tiled.

If set to false it will be stretched to fit the given area. Instances will require redrawing before this change is reflected. This effects both dimensions. Tiling is recommended for all applications.

Reimplemented in Rectangle.

◆ SetSideTiling()

virtual void SetSideTiling ( bool  value)
virtual

Sets whether the side parts (tm, ml, mr, bm) would be tiled.

If set to false it will be stretched to fit the given area. Instances will require redrawing before this change is reflected. Tiling is recommended for all applications.

Reimplemented in Rectangle.

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