Selection Struct Reference

#include <viewinterface.hh>

Collaboration diagram for Selection:

Public Types
using	Point = Scroom::Utils::Point< double >

Public Member Functions
	Selection (double x, double y)
	Selection (Point point)
	Selection (Point start_, Point end_)
Selection &	operator= (const Point &p)
double	width () const
double	height () const
double	length () const

Public Attributes
Point	start
Point	end

Detailed Description

Structure that represents a selection made by the user.

Member Typedef Documentation

Point

using Selection::Point = Scroom::Utils::Point<double>

Constructor & Destructor Documentation

Selection() [1/3]

Selection::Selection ( double  x, double  y  )

inline

    : Selection(Scroom::Utils::make_point(x, y))
  {
  }

Selection() [2/3]

Selection::Selection ( Point  point )

inlineexplicit

    : Selection(point, point)
  {
  }

Selection() [3/3]

Selection::Selection ( Point  start_, Point  end_  )

inline

    : start(start_)
    , end(end_)
  {
  }

Member Function Documentation

height()

double Selection::height ( ) const

inline

{ return abs(end.y - start.y); }

Referenced by MeasureHandler::displayMeasurement(), and length().

Here is the caller graph for this function:

length()

double Selection::length ( ) const

inline

{ return std::hypot(width(), height()); }

Referenced by MeasureHandler::displayMeasurement().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

Selection & Selection::operator= ( const Point &  p )

inline

  {
    start = p;
    end = p;
    return *this;
  }

width()

double Selection::width ( ) const

inline

{ return abs(end.x - start.x); }

Referenced by MeasureHandler::displayMeasurement(), and length().

Here is the caller graph for this function:

Member Data Documentation

end

Point Selection::end

Referenced by MeasureHandler::displayMeasurement(), height(), operator=(), and width().

start

Point Selection::start

Referenced by MeasureHandler::displayMeasurement(), height(), operator=(), and width().

---

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

• libs/plugin-interfaces/inc/scroom/viewinterface.hh