TransformPresentation Class Reference

#include <transformpresentation.hh>

Inheritance diagram for TransformPresentation:

Collaboration diagram for TransformPresentation:

Public Types
using	Ptr = boost::shared_ptr< TransformPresentation >
Public Types inherited from PresentationInterface
using	Ptr = boost::shared_ptr< PresentationInterface >
using	WeakPtr = boost::weak_ptr< PresentationInterface >
Public Types inherited from Viewable
using	Ptr = boost::shared_ptr< Viewable >
using	WeakPtr = boost::weak_ptr< Viewable >
Public Types inherited from Scroom::Utils::Observable< T >
using	Observer = boost::shared_ptr< T >
using	Ptr = boost::shared_ptr< Observable< T > >
Public Types inherited from Colormappable
using	Ptr = boost::shared_ptr< Colormappable >
using	WeakPtr = boost::weak_ptr< Colormappable >
Public Types inherited from PipetteViewInterface
using	Ptr = boost::shared_ptr< PipetteViewInterface >
Public Types inherited from ShowMetadataInterface
using	Ptr = boost::shared_ptr< ShowMetadataInterface >

Public Member Functions
void	open (ViewInterface::WeakPtr vi) override
void	close (ViewInterface::WeakPtr vi) override
Scroom::Utils::Rectangle< double >	getRect () override
void	redraw (ViewInterface::Ptr const &vi, cairo_t *cr, Scroom::Utils::Rectangle< double > presentationArea, int zoom) override
bool	getProperty (const std::string &name, std::string &value) override
bool	isPropertyDefined (const std::string &name) override
std::string	getTitle () override
Scroom::Utils::Point< double >	getAspectRatio () const override
PipetteLayerOperations::PipetteColor	getPixelAverages (Scroom::Utils::Rectangle< double > area) override
void	setColormap (Colormap::Ptr colormap) override
Colormap::Ptr	getOriginalColormap () override
int	getNumberOfColors () override
Color	getMonochromeColor () override
void	setMonochromeColor (const Color &c) override
void	setTransparentBackground () override
void	disableTransparentBackground () override
bool	getTransparentBackground () override
void	showMetadata (GtkWindow *parent) override
Public Member Functions inherited from Scroom::Utils::Observable< T >
	Observable ()
	~Observable () override
	Observable (const Observable &)=delete
	Observable (Observable &&)=delete
Observable	operator= (const Observable &)=delete
Observable	operator= (Observable &&)=delete
Scroom::Bookkeeping::Token	registerStrongObserver (Observer const &observer)
Scroom::Bookkeeping::Token	registerObserver (ObserverWeak const &observer)
For monochrome presentations: Set/Get the current color
Manipulate the "Transparent Background" setting of the presentation
Public Member Functions inherited from Scroom::Utils::Base
	Base ()=default
	Base (const Base &)=delete
	Base (Base &&)=delete
Base &	operator= (const Base &)=delete
Base &	operator= (Base &&)=delete
virtual	~Base ()=default
template<typename R >
boost::shared_ptr< R >	shared_from_this ()
template<typename R >
boost::shared_ptr< R const >	shared_from_this () const

Static Public Member Functions
static Ptr	create (PresentationInterface::Ptr const &presentation, TransformationData::Ptr const &transformationData)

Private Member Functions
	TransformPresentation (PresentationInterface::Ptr const &presentation, TransformationData::Ptr transformationData)

Private Attributes
TransformationData::Ptr	transformationData
PresentationInterface::Ptr	presentation
Colormappable::Ptr	colormappable
ShowMetadataInterface::Ptr	showMetaDataInterface
std::map< ViewInterface::WeakPtr, Detail::ViewData::Ptr >	viewData

Additional Inherited Members
Protected Member Functions inherited from PresentationBase
void	observerAdded (Viewable::Ptr const &viewable, Scroom::Bookkeeping::Token const &t) override
Protected Member Functions inherited from Scroom::Utils::Observable< T >
std::list< Observer >	getObservers ()
virtual void	observerAdded (Observer const &observer, Scroom::Bookkeeping::Token const &token)

Member Typedef Documentation

Ptr

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

Constructor & Destructor Documentation

TransformPresentation()

TransformPresentation::TransformPresentation ( PresentationInterface::Ptr const &  presentation, TransformationData::Ptr  transformationData  )

private

  : transformationData(std::move(transformationData_))
  , presentation(presentation_)
  , colormappable(boost::dynamic_pointer_cast<Colormappable>(presentation_))
  , showMetaDataInterface(boost::dynamic_pointer_cast<ShowMetadataInterface>(presentation_))
{
}

Referenced by create().

Here is the caller graph for this function:

Member Function Documentation

close()

void TransformPresentation::close ( ViewInterface::WeakPtr  vi )

overridevirtual

Gets called just before the View is destroyed

Precondition

Should be called from within a Gdk critical section (i.e. between gdk_threads_enter() and gdk_threads_leave() calls)

Reimplemented from PresentationBase.

{
  auto data = viewData.at(viewInterface);
  viewData.erase(viewInterface);
 
  PresentationBase::close(viewInterface);
  presentation->close(data);
}

Here is the call graph for this function:

create()

TransformPresentation::Ptr TransformPresentation::create ( PresentationInterface::Ptr const &  presentation, TransformationData::Ptr const &  transformationData  )

static

{
  return Ptr(new TransformPresentation(presentation, transformationData));
}

Referenced by anonymous_namespace{tiledbitmappresentation.cc}::OpenTiledBitmapAsPresentation::open(), and TEST().

Here is the call graph for this function:

Here is the caller graph for this function:

disableTransparentBackground()

void TransformPresentation::disableTransparentBackground ( )

overridevirtual

Implements Colormappable.

{ colormappable->disableTransparentBackground(); }

getAspectRatio()

Scroom::Utils::Point< double > TransformPresentation::getAspectRatio ( ) const

overridevirtual

Reimplemented from PresentationInterface.

{ return transformationData->getAspectRatio(); }

Referenced by getPixelAverages().

Here is the caller graph for this function:

getMonochromeColor()

Color TransformPresentation::getMonochromeColor ( )

overridevirtual

Implements Colormappable.

{ return colormappable->getMonochromeColor(); }

getNumberOfColors()

int TransformPresentation::getNumberOfColors ( )

overridevirtual

Retrieve the number of colors in use by the presentation

Implements Colormappable.

{ return colormappable->getNumberOfColors(); }

getOriginalColormap()

Colormap::Ptr TransformPresentation::getOriginalColormap ( )

overridevirtual

Retrieve the images colormap (if any)

Implements Colormappable.

{ return colormappable->getOriginalColormap(); }

getPixelAverages()

PipetteLayerOperations::PipetteColor TransformPresentation::getPixelAverages ( Scroom::Utils::Rectangle< double >  area )

overridevirtual

Returns the average pixel values for each component, contained in the area.

Parameters

area	selected area to get the pixel values from.

Implements PipetteViewInterface.

{
  PipetteViewInterface::Ptr const pipettePresentation = boost::dynamic_pointer_cast<PipetteViewInterface>(presentation);
  require(pipettePresentation);
  return pipettePresentation->getPixelAverages(area / getAspectRatio());
}

Here is the call graph for this function:

getProperty()

bool TransformPresentation::getProperty ( const std::string &  name, std::string &  value  )

overridevirtual

Return the value of the requested property

Parameters

[in]	name	The name of the requested property
[out]	value	The value of the requested property

Return values

true	if the property existed
false	if the property didn't exist

Implements PresentationInterface.

{
  return presentation->getProperty(name, value);
}

getRect()

Scroom::Utils::Rectangle< double > TransformPresentation::getRect ( )

overridevirtual

Return the dimensions of your presentation

Implements PresentationInterface.

{
  return presentation->getRect() * transformationData->getAspectRatio();
}

getTitle()

std::string TransformPresentation::getTitle ( )

overridevirtual

Return the title of the presentation

Implements PresentationInterface.

{ return presentation->getTitle(); }

getTransparentBackground()

bool TransformPresentation::getTransparentBackground ( )

overridevirtual

Implements Colormappable.

{ return colormappable->getTransparentBackground(); }

isPropertyDefined()

bool TransformPresentation::isPropertyDefined ( const std::string &  name )

overridevirtual

Return true if the named property exists

Implements PresentationInterface.

{ return presentation->isPropertyDefined(name); }

open()

void TransformPresentation::open ( ViewInterface::WeakPtr  vi )

overridevirtual

Gets called just after the View is created

Precondition

Should be called from within a Gdk critical section (i.e. between gdk_threads_enter() and gdk_threads_leave() calls)

Reimplemented from PresentationBase.

{
  auto [it, inserted] = viewData.insert({viewInterface, Detail::ViewData::create(viewInterface)});
  require(inserted);
  auto& [_, data] = *it;
 
  presentation->open(data);
  PresentationBase::open(viewInterface);
}

Here is the call graph for this function:

redraw()

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

overridevirtual

Draw the requested ara at the requested zoom level

Parameters

vi	The ViewInterface on whose behalf the request is made
cr	The context to draw the area on
presentationArea	the area that is to be drawn. The given x and y coordinates should map on 0,0 of the given context cr.
zoom	The requested zoom level. One pixel of your presentation should have size 2**zoom when drawn. zoom may be negative.

Implements PresentationInterface.

{
  Scroom::Utils::Point<double> const aspectRatio = transformationData->getAspectRatio();
  const auto                         data        = viewData.at(vi);
 
  if(data->presentationArea != presentationArea || data->zoom != zoom)
  {
    data->image.reset();
  }
  if(!data->image)
  {
    auto pixelSize = pixelSizeFromZoom(zoom);
    auto viewArea  = ceil((presentationArea * pixelSize / aspectRatio).getSize()).to<int>();
 
    data->image = Scroom::Bitmap::BitmapSurface::create(viewArea.x, viewArea.y, CAIRO_FORMAT_ARGB32);
 
    cairo_surface_t* surface  = data->image->get();
    cairo_t*         image_cr = cairo_create(surface);
 
    presentation->redraw(data, image_cr, presentationArea / aspectRatio, zoom);
 
    cairo_destroy(image_cr);
  }
 
  cairo_save(cr);
  cairo_scale(cr, aspectRatio.x, aspectRatio.y);
  cairo_set_source_surface(cr, data->image->get(), 0, 0);
  cairo_paint(cr);
  cairo_restore(cr);
}

Here is the call graph for this function:

setColormap()

void TransformPresentation::setColormap ( Colormap::Ptr  colormap )

overridevirtual

Request that the presentation use the given colormap

Implements Colormappable.

{ colormappable->setColormap(colormap); }

setMonochromeColor()

void TransformPresentation::setMonochromeColor ( const Color &  c )

overridevirtual

Implements Colormappable.

{ colormappable->setMonochromeColor(c); }

setTransparentBackground()

void TransformPresentation::setTransparentBackground ( )

overridevirtual

Implements Colormappable.

{ colormappable->setTransparentBackground(); }

showMetadata()

void TransformPresentation::showMetadata ( GtkWindow *  parent )

overridevirtual

Request to show a window containing the presentation metadata

Parameters

parent

the parent window, if found. Nullptr otherwise

Implements ShowMetadataInterface.

{ showMetaDataInterface->showMetadata(parent); }

Member Data Documentation

colormappable

Colormappable::Ptr TransformPresentation::colormappable

private

Referenced by disableTransparentBackground(), getMonochromeColor(), getNumberOfColors(), getOriginalColormap(), getTransparentBackground(), setColormap(), setMonochromeColor(), and setTransparentBackground().

presentation

PresentationInterface::Ptr TransformPresentation::presentation

private

Referenced by close(), create(), getPixelAverages(), getProperty(), getRect(), getTitle(), isPropertyDefined(), open(), and redraw().

showMetaDataInterface

ShowMetadataInterface::Ptr TransformPresentation::showMetaDataInterface

private

Referenced by showMetadata().

transformationData

TransformationData::Ptr TransformPresentation::transformationData

private

Referenced by create(), getAspectRatio(), getRect(), and redraw().

viewData

std::map<ViewInterface::WeakPtr, Detail::ViewData::Ptr> TransformPresentation::viewData

private

Referenced by close(), open(), and redraw().

---

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

• inc/scroom/transformpresentation.hh
• libs/scroom/src/transformpresentation.cc