canvas::SpriteSurface Class Reference

Canvas surface containing sprites. More...

#include <spritesurface.hxx>

Inheritance diagram for canvas::SpriteSurface:

Collaboration diagram for canvas::SpriteSurface:

Public Types
typedef ::rtl::Reference< SpriteSurface >	Reference

Public Member Functions
virtual void	showSprite (const Sprite::Reference &rSprite)=0
	Sprites should call this from XSprite::show() More...
virtual void	hideSprite (const Sprite::Reference &rSprite)=0
	Sprites should call this from XSprite::hide() More...
virtual void	moveSprite (const Sprite::Reference &rSprite, const ::basegfx::B2DPoint &rOldPos, const ::basegfx::B2DPoint &rNewPos, const ::basegfx::B2DVector &rSpriteSize)=0
	Sprites should call this from XSprite::move() More...
virtual void	updateSprite (const Sprite::Reference &rSprite, const ::basegfx::B2DPoint &rPos, const ::basegfx::B2DRange &rUpdateArea)=0
	Sprites should call this when some part of the content has changed. More...

Protected Member Functions
	~SpriteSurface ()

Detailed Description

Canvas surface containing sprites.

Every canvas surface that contains sprites must implement this interface, when employing the canvas base framework. The methods provided here are used from the individual sprites to notify the canvas about necessary screen updates.

Definition at line 35 of file spritesurface.hxx.

Member Typedef Documentation

Reference

typedef ::rtl::Reference< SpriteSurface > canvas::SpriteSurface::Reference

Definition at line 38 of file spritesurface.hxx.

Constructor & Destructor Documentation

~SpriteSurface()

canvas::SpriteSurface::~SpriteSurface ( )

inlineprotected

Definition at line 63 of file spritesurface.hxx.

Member Function Documentation

hideSprite()

virtual void canvas::SpriteSurface::hideSprite ( const Sprite::Reference &  rSprite )

pure virtual

Sprites should call this from XSprite::hide()

moveSprite()

virtual void canvas::SpriteSurface::moveSprite ( const Sprite::Reference &  rSprite, const ::basegfx::B2DPoint &  rOldPos, const ::basegfx::B2DPoint &  rNewPos, const ::basegfx::B2DVector &  rSpriteSize  )

pure virtual

Sprites should call this from XSprite::move()

showSprite()

virtual void canvas::SpriteSurface::showSprite ( const Sprite::Reference &  rSprite )

pure virtual

Sprites should call this from XSprite::show()

updateSprite()

virtual void canvas::SpriteSurface::updateSprite ( const Sprite::Reference &  rSprite, const ::basegfx::B2DPoint &  rPos, const ::basegfx::B2DRange &  rUpdateArea  )

pure virtual

Sprites should call this when some part of the content has changed.

That includes show/hide, i.e. for show, both showSprite() and updateSprite() must be called.

---

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

• spritesurface.hxx