canvas::Sprite Class Reference

Helper interface to connect SpriteCanvas with various sprite implementations. More...

#include <sprite.hxx>

Inheritance diagram for canvas::Sprite:

Collaboration diagram for canvas::Sprite:

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

Public Member Functions
virtual bool	isAreaUpdateOpaque (const ::basegfx::B2DRange &rUpdateArea) const =0
	Query whether sprite update will fully cover the given area. More...
virtual bool	isContentChanged () const =0
	Query whether content has changed. More...
virtual ::basegfx::B2DPoint	getPosPixel () const =0
	Query position of the left, top pixel of the sprite. More...
virtual ::basegfx::B2DVector	getSizePixel () const =0
	Query size of the sprite in pixel. More...
virtual ::basegfx::B2DRange	getUpdateArea () const =0
	Get area that is currently covered by the sprite. More...
virtual double	getPriority () const =0
	Query sprite priority. More...

Protected Member Functions
	~Sprite ()

Detailed Description

Helper interface to connect SpriteCanvas with various sprite implementations.

This interface should be implemented from every sprite class, as it provides essential repaint and update area facilitates.

Derive: \n typically, each canvas implementation will derive

another interface from this one, that adds rendering functionality (which, of course, is impossible here in a generic way)

Definition at line 50 of file inc/base/sprite.hxx.

Member Typedef Documentation

Reference

typedef ::rtl::Reference< Sprite > canvas::Sprite::Reference

Definition at line 53 of file inc/base/sprite.hxx.

Constructor & Destructor Documentation

~Sprite()

canvas::Sprite::~Sprite ( )

inlineprotected

Definition at line 91 of file inc/base/sprite.hxx.

Member Function Documentation

getPosPixel()

virtual ::basegfx::B2DPoint canvas::Sprite::getPosPixel ( ) const

pure virtual

Query position of the left, top pixel of the sprite.

Referenced by vclcanvas::SpriteCanvasHelper::genericUpdate().

getPriority()

virtual double canvas::Sprite::getPriority ( ) const

pure virtual

Query sprite priority.

getSizePixel()

virtual ::basegfx::B2DVector canvas::Sprite::getSizePixel ( ) const

pure virtual

Query size of the sprite in pixel.

getUpdateArea()

virtual ::basegfx::B2DRange canvas::Sprite::getUpdateArea ( ) const

pure virtual

Get area that is currently covered by the sprite.

This area is already adapted to clipping, alpha and transformation state of this sprite.

isAreaUpdateOpaque()

virtual bool canvas::Sprite::isAreaUpdateOpaque ( const ::basegfx::B2DRange &  rUpdateArea ) const

pure virtual

Query whether sprite update will fully cover the given area.

Use this method to determine whether any background content (regardless of static or sprite) needs an update before rendering this sprite.

Returns

true, if sprite redraw will fully overwrite given area (and thus, the background need not be redrawn beforehand).

isContentChanged()

virtual bool canvas::Sprite::isContentChanged ( ) const

pure virtual

Query whether content has changed.

---

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

• inc/base/sprite.hxx