ILineProvider Class Reference

Interface for LineProviders. More...

Inheritance diagram for ILineProvider:

Public Member Functions
	ILineProvider (Orientation orientation)
virtual RectangularAnimation &	CreateEnd () const =0
	Creates a start animation without controller. This function should always return an animation. More...
virtual RectangularAnimation &	CreateMiddle () const =0
	Creates a start animation without controller. This function should always return an animation. More...
virtual RectangularAnimation &	CreateStart () const =0
	Creates a start animation without controller. This function should always return an animation. More...
virtual Orientation	GetOrientation () const
	Returns the orientation of the line provider. More...
virtual bool	GetTiling () const
	Returns if the middle part will be tiled. More...
virtual ILineProvider &	MoveOutProvider () override=0
	This function moves this animation provider into a new provider. More...
virtual void	SetOrientation (Orientation value)
	Changes the orientation of the provider. More...
virtual void	SetTiling (bool value)
	Sets whether the middle part 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 LineProviders.

Constructor & Destructor Documentation

ILineProvider()

ILineProvider

(

Orientation

orientation

)

Member Function Documentation

CreateEnd()

virtual RectangularAnimation& CreateEnd ( ) const

pure virtual

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

Implemented in Line, and basic_LineProvider< A_ >.

CreateMiddle()

virtual RectangularAnimation& CreateMiddle ( ) const

pure virtual

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

Implemented in Line, and basic_LineProvider< A_ >.

CreateStart()

virtual RectangularAnimation& CreateStart ( ) const

pure virtual

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

Implemented in Line, and basic_LineProvider< A_ >.

GetOrientation()

virtual Orientation GetOrientation ( ) const

virtual

Returns the orientation of the line provider.

Reimplemented in Line.

GetTiling()

virtual bool GetTiling ( ) const

virtual

Returns if the middle part will be tiled.

Reimplemented in Line.

MoveOutProvider()

virtual ILineProvider& 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 Line, and basic_LineProvider< A_ >.

SetOrientation()

virtual void SetOrientation ( Orientation  value )

virtual

Changes the orientation of the provider.

Instances will require redrawing before this change is reflected.

Reimplemented in Line.

SetTiling()

virtual void SetTiling ( 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. Tiling is recommended for all applications.

Reimplemented in Line.

---

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

• Gorgon/Graphics/Line.h