MeasureHandler Class Reference

#include <measure.hh>

Inheritance diagram for MeasureHandler:

Collaboration diagram for MeasureHandler:

Public Types
using	Ptr = std::shared_ptr< MeasureHandler >
Public Types inherited from ToolStateListener
using	Ptr = std::shared_ptr< ToolStateListener >
Public Types inherited from PostRenderer
using	Ptr = std::shared_ptr< PostRenderer >
Public Types inherited from SelectionListener
using	Ptr = std::shared_ptr< SelectionListener >

Public Member Functions
void	render (ViewInterface::Ptr const &vi, cairo_t *cr, Scroom::Utils::Rectangle< double > presentationArea, int zoom) override
void	onSelectionStart (Selection p, ViewInterface::Ptr view) override
void	onSelectionUpdate (Selection s, ViewInterface::Ptr view) override
void	onSelectionEnd (Selection s, ViewInterface::Ptr view) override
void	onEnable () override
void	onDisable () override
Public Member Functions inherited from SelectionListener
virtual std::string	getSelectionType ()
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 >
std::shared_ptr< R >	shared_from_this ()
template<typename R >
std::shared_ptr< R const >	shared_from_this () const

Static Public Member Functions
static Ptr	create ()

Private Member Functions
virtual void	displayMeasurement (const ViewInterface::Ptr &view)
virtual void	drawCross (cairo_t *cr, Scroom::Utils::Point< double > p)

Private Attributes
std::optional< Selection >	selection
bool	enabled {false}

Member Typedef Documentation

Ptr

using MeasureHandler::Ptr = std::shared_ptr<MeasureHandler>

Member Function Documentation

create()

MeasureHandler::Ptr MeasureHandler::create ( )

static

{ return std::make_shared<MeasureHandler>(); }

Referenced by Measure::viewAdded().

Here is the caller graph for this function:

displayMeasurement()

void MeasureHandler::displayMeasurement ( const ViewInterface::Ptr &  view )

privatevirtual

{
  const auto aspectRatio = getAspectRatio(view->getCurrentPresentation());
  const Selection tweaked(selection->start / aspectRatio, selection->end / aspectRatio);
 
  view->setStatusMessage(
    fmt::format(
      "l: {:.1f}, dx: {}, dy: {}, from: {}, to: {}",
      tweaked.length(),
      tweaked.width(),
      tweaked.height(),
      tweaked.start,
      tweaked.end
    )
  );
}

Referenced by onSelectionEnd(), and onSelectionUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

drawCross()

void MeasureHandler::drawCross ( cairo_t *  cr, Scroom::Utils::Point< double >  p  )

privatevirtual

{
  static const int size = 10;
  cairo_move_to(cr, p.x - size, p.y);
  cairo_line_to(cr, p.x + size, p.y);
  cairo_move_to(cr, p.x, p.y - size);
  cairo_line_to(cr, p.x, p.y + size);
}

Referenced by render().

Here is the caller graph for this function:

onDisable()

void MeasureHandler::onDisable ( )

overridevirtual

Then function is called whenever the tool button is deselected.

Implements ToolStateListener.

{
  selection.reset();
  enabled = false;
}

onEnable()

void MeasureHandler::onEnable ( )

overridevirtual

This function is called whenever the tool button is selected.

Implements ToolStateListener.

{ enabled = true; }

onSelectionEnd()

void MeasureHandler::onSelectionEnd ( Selection  selection, ViewInterface::Ptr  view  )

overridevirtual

This function is called whenever the selection ends. That is, whenever the user releases the mouse button that was pressed.

The final selection is passed as an argument.

See also

Selection

Implements SelectionListener.

{
  if(enabled)
  {
    selection = s;
    displayMeasurement(view);
  }
}

Here is the call graph for this function:

onSelectionStart()

void MeasureHandler::onSelectionStart ( Selection  selection, ViewInterface::Ptr  view  )

overridevirtual

This function is called whenever the user clicks a view. The point that is clicked is passed as an argument.

The passed point is a point in the presentation coordinate space.

Implements SelectionListener.

{}

onSelectionUpdate()

void MeasureHandler::onSelectionUpdate ( Selection  selection, ViewInterface::Ptr  view  )

overridevirtual

This function is called whenever the selection updates. That is, whenever the user moves the mouse while keeping the mouse button pressed.

The updated selection is passed as an argument.

See also

Selection

Implements SelectionListener.

{
  if(enabled)
  {
    selection = s;
    displayMeasurement(view);
  }
}

Here is the call graph for this function:

render()

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

overridevirtual

This function is called after the presentation finishes redrawing.

Parameters

vi	The ViewInterface on whose behalf the request is made
cr	The context to with, the origin of the context is translated to be the same as the origin of the presentation.
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 should have size 2**zoom when drawn. zoom may be negative.

Implements PostRenderer.

{
  if(selection)
  {
    const auto pixelSize = pixelSizeFromZoom(zoom);
    const auto start = (selection->start - presentationArea.getTopLeft()) * pixelSize;
    const auto end = (selection->end - presentationArea.getTopLeft()) * pixelSize;
 
    cairo_set_line_width(cr, 1);
    cairo_set_source_rgb(cr, 0.75, 0, 0); // Dark Red
    drawCross(cr, start);
    drawCross(cr, end);
    cairo_stroke(cr);
    cairo_set_source_rgb(cr, 1, 0, 0); // Red
    cairo_move_to(cr, start.x, start.y);
    cairo_line_to(cr, end.x, end.y);
    cairo_stroke(cr);
  }
}

Here is the call graph for this function:

Member Data Documentation

enabled

bool MeasureHandler::enabled {false}

private

{false};

Referenced by onDisable(), onEnable(), onSelectionEnd(), and onSelectionUpdate().

selection

std::optional<Selection> MeasureHandler::selection

private

Referenced by displayMeasurement(), onDisable(), onSelectionEnd(), onSelectionUpdate(), and render().

---

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

• plugins/measure/src/measure.hh
• plugins/measure/src/measure.cc