basic_PointerProvider< A_ > Class Template Reference

This class stores information that allows an animated pointer to be created. More...

Inheritance diagram for basic_PointerProvider< A_ >:

Public Types
using	AnimationType = basic_AnimatedPointer< A_ >

Public Member Functions
	basic_PointerProvider (basic_PointerProvider &&other)
	Move constructor. More...
	basic_PointerProvider (const basic_PointerProvider &)=delete
	basic_PointerProvider (Geometry::Point hotspot={0, 0})
virtual	~basic_PointerProvider ()
AnimationType &	CreateAnimation (bool create=true) const override
	Creates a pointer from this provider. More...
AnimationType &	CreateAnimation (Gorgon::Animation::ControllerBase &timer) const override
	Creates a pointer from this provider. More...
AnimationType	CreatePointer (bool create=true) const
	Creates a pointer from this provider, just a rename for CreateAnimation. More...
AnimationType	CreatePointer (Gorgon::Animation::Timer &timer) const
	Creates a pointer from this provider. More...
Geometry::Point	GetHotspot () const
	Returns the hotspot of the provider. More...
void	SetHotspot (Geometry::Point value)
	Sets the hotspot of the pointer. More...

Protected Attributes
Geometry::Point	hotspot
	Hotspot will be transferred to newly created pointers. More...
bool	owned
	Whether the animation is owned by this object. More...

Detailed Description

template<class A_>
class Gorgon::Graphics::basic_PointerProvider< A_ >

This class stores information that allows an animated pointer to be created.

Member Typedef Documentation

AnimationType

using AnimationType = basic_AnimatedPointer<A_>

Constructor & Destructor Documentation

basic_PointerProvider() [1/3]

basic_PointerProvider ( Geometry::Point  hotspot = {0,0} )

explicit

basic_PointerProvider() [2/3]

basic_PointerProvider

(

basic_PointerProvider< A_ > &&

other

)

Move constructor.

basic_PointerProvider() [3/3]

basic_PointerProvider ( const basic_PointerProvider< A_ > &  )

delete

~basic_PointerProvider()

virtual ~basic_PointerProvider ( )

virtual

Member Function Documentation

CreateAnimation() [1/2]

AnimationType& CreateAnimation ( bool  create = true ) const

override

Creates a pointer from this provider.

CreateAnimation() [2/2]

AnimationType& CreateAnimation ( Gorgon::Animation::ControllerBase &  timer ) const

override

Creates a pointer from this provider.

CreatePointer() [1/2]

AnimationType CreatePointer

(

bool

create = true

)

const

Creates a pointer from this provider, just a rename for CreateAnimation.

CreatePointer() [2/2]

AnimationType CreatePointer

(

Gorgon::Animation::Timer &

timer

)

const

Creates a pointer from this provider.

GetHotspot()

Geometry::Point GetHotspot

(

)

const

Returns the hotspot of the provider.

References basic_PointerProvider< A_ >::hotspot.

SetHotspot()

void SetHotspot

(

Geometry::Point

value

)

Sets the hotspot of the pointer.

References basic_PointerProvider< A_ >::hotspot.

Member Data Documentation

hotspot

Geometry::Point hotspot

protected

Hotspot will be transferred to newly created pointers.

owned

bool owned

protected

Whether the animation is owned by this object.

---

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

• Gorgon/Graphics/Pointer.h