Scroom  0.14
TiledBitmapInterface Class Referenceabstract

#include <tiledbitmapinterface.hh>

Inheritance diagram for TiledBitmapInterface:
Inheritance graph
Collaboration diagram for TiledBitmapInterface:
Collaboration graph

Public Types

using Ptr = boost::shared_ptr< TiledBitmapInterface >
 
- Public Types inherited from Viewable
using Ptr = boost::shared_ptr< Viewable >
 
using WeakPtr = boost::weak_ptr< Viewable >
 

Public Member Functions

virtual void setSource (SourcePresentation::Ptr sp)=0
 
virtual boost::shared_ptr< LayergetBottomLayer ()=0
 
virtual void redraw (ViewInterface::Ptr const &vi, cairo_t *cr, const Scroom::Utils::Rectangle< double > &presentationArea, int zoom)=0
 
virtual void clearCaches (ViewInterface::Ptr vi)=0
 
- Public Member Functions inherited from Viewable
virtual void open (ViewInterface::WeakPtr vi)=0
 
virtual void close (ViewInterface::WeakPtr vi)=0
 

Detailed Description

Interact with your TiledBitmap

Member Typedef Documentation

◆ Ptr

using TiledBitmapInterface::Ptr = boost::shared_ptr<TiledBitmapInterface>

Member Function Documentation

◆ clearCaches()

virtual void TiledBitmapInterface::clearCaches ( ViewInterface::Ptr  vi)
pure virtual

Clear all bitmap caches related to the view.

You'd typically do this if the bitmap has somehow changed appearance, for example when switching to a new Colormap.

Parameters
viThe ViewInterface for which to clear the caches

Implemented in TiledBitmap.

◆ getBottomLayer()

virtual boost::shared_ptr<Layer> TiledBitmapInterface::getBottomLayer ( )
pure virtual

Retrieve the bottom layer of the TiledBitmap.

This allows you to fill the layer with data yourself, instead of relying on setSource()

See also
setSource()

Implemented in TiledBitmap.

◆ redraw()

virtual void TiledBitmapInterface::redraw ( ViewInterface::Ptr const &  vi,
cairo_t *  cr,
const Scroom::Utils::Rectangle< double > &  presentationArea,
int  zoom 
)
pure virtual

Redraw a portion of the bitmap.

This is typically called from PresentationInterface::redraw()

See also
PresentationInterface::redraw()

Implemented in TiledBitmap.

◆ setSource()

virtual void TiledBitmapInterface::setSource ( SourcePresentation::Ptr  sp)
pure virtual

Provide bitmap data to the TiledBitmap

Bitmap data will be loaded and pre-scaled in a fashion that least loads cpu and memory.

Parameters
spsource of the bitmap data

Implemented in TiledBitmap.


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