sirius::ZoomRatio Class Reference

Data class that represents zoom ratio as input_resolution/output_resolution. More...

#include <sirius/types.h>

Public Member Functions
	ZoomRatio ()=default
	Instantiate a zoom ratio 1:1. More...
	~ZoomRatio ()=default
	ZoomRatio (const ZoomRatio &)=default
	ZoomRatio (ZoomRatio &&)=default
ZoomRatio &	operator= (const ZoomRatio &)=default
ZoomRatio &	operator= (ZoomRatio &&)=default
int	input_resolution () const
int	output_resolution () const
double	ratio () const
bool	IsRealZoom () const

Static Public Member Functions
static ZoomRatio	Create (const std::string &ratio_string)
	Create an instance from a formatted string (input_resolution:output_resolution) More...
static ZoomRatio	Create (int input_resolution, int output_resolution=1)
	Zoom ratio as input_resolution/output_resolution Reduce the ratio. More...

Detailed Description

Data class that represents zoom ratio as input_resolution/output_resolution.

Constructor & Destructor Documentation

ZoomRatio() [1/3]

sirius::ZoomRatio::ZoomRatio ( )

default

Instantiate a zoom ratio 1:1.

~ZoomRatio()

sirius::ZoomRatio::~ZoomRatio ( )

default

ZoomRatio() [2/3]

sirius::ZoomRatio::ZoomRatio ( const ZoomRatio &  )

default

ZoomRatio() [3/3]

sirius::ZoomRatio::ZoomRatio ( ZoomRatio &&  )

default

Member Function Documentation

Create() [1/2]

static ZoomRatio sirius::ZoomRatio::Create ( const std::string &  ratio_string )

static

Create an instance from a formatted string (input_resolution:output_resolution)

Parameters

ratio_string

should be formatted as "input_resolution:output_resolution"

Returns

zoom ratio

Exceptions

sirius::Exception

if string format or ratio is invalid

Create() [2/2]

static ZoomRatio sirius::ZoomRatio::Create ( int  input_resolution, int  output_resolution = 1  )

static

Zoom ratio as input_resolution/output_resolution Reduce the ratio.

Parameters

input_resolution	numerator of the ratio
output_resolution	denominator of the ratio

Returns

zoom ratio

Exceptions

sirius::Exception	if ratio is invalid
std::invalid_argument	if conversion from string to int failed

input_resolution()

int sirius::ZoomRatio::input_resolution ( ) const

inline

IsRealZoom()

bool sirius::ZoomRatio::IsRealZoom

(

)

const

operator=() [1/2]

ZoomRatio& sirius::ZoomRatio::operator= ( const ZoomRatio &  )

default

operator=() [2/2]

ZoomRatio& sirius::ZoomRatio::operator= ( ZoomRatio &&  )

default

output_resolution()

int sirius::ZoomRatio::output_resolution ( ) const

inline

ratio()

double sirius::ZoomRatio::ratio ( ) const

inline

---

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

• src/sirius/types.h