LibreOffice Module canvas (master)  1
Public Types | Public Member Functions | Protected Member Functions | List of all members
canvas::Sprite Class Referenceabstract

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

#include <sprite.hxx>

Inheritance diagram for canvas::Sprite:
[legend]
Collaboration diagram for canvas::Sprite:
[legend]

Public Types

typedef ::rtl::Reference< SpriteReference
 

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:
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 51 of file include/canvas/base/sprite.hxx.

Member Typedef Documentation

Definition at line 54 of file include/canvas/base/sprite.hxx.

Constructor & Destructor Documentation

canvas::Sprite::~Sprite ( )
inlineprotected

Definition at line 92 of file include/canvas/base/sprite.hxx.

Member Function Documentation

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

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

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

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

Query sprite priority.

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

Query size of the sprite in pixel.

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.

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).
virtual bool canvas::Sprite::isContentChanged ( ) const
pure virtual

Query whether content has changed.


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