ZoomDescriptor Class Reference

Describes an zoom setting for the display. More...

#include <cvb/ui/ui.hpp>

Public Member Functions
bool	operator== (const ZoomDescriptor &zoomDescriptor) const noexcept
	Compares to an other zoom descriptor.
bool	operator!= (const ZoomDescriptor &zoomDescriptor) const noexcept
	Compares to an other zoom descriptor.
	ZoomDescriptor (ZoomID id) noexcept
	Constructor for a standard zoom descriptor.
	ZoomDescriptor (double customFactor) noexcept
	Constructor for a custom zoom descriptor.

Public Attributes
ZoomID	ID = ZoomID::Invalid
	Zoom identifier for known factors.
double	Factor = std::numeric_limits<double>::quiet_NaN()
	Numeric representation of the zoom factor.

Detailed Description

Describes an zoom setting for the display.

Constructor & Destructor Documentation

ZoomDescriptor() [1/2]

ZoomDescriptor ( ZoomID id )

inlineexplicitnoexcept

Constructor for a standard zoom descriptor.

Parameters

[in]

id

Zoom identifier to set the factor. This does not work for CvbZoomID::Custom and CvbZoomID::Panorama.

Exceptions

Does	not throw any exception.

ZoomDescriptor() [2/2]

ZoomDescriptor ( double customFactor )

inlineexplicitnoexcept

Constructor for a custom zoom descriptor.

Parameters

[in]

customFactor

A custom zoom factor. The identifier will always be custom, even if, the numeric factor matches a known identifier.

Exceptions

Does	not throw any exception.

Member Function Documentation

operator!=()

bool operator!= ( const ZoomDescriptor & zoomDescriptor ) const

inlinenoexcept

Compares to an other zoom descriptor.

Parameters

[in]

zoomDescriptor

Other zoom descriptor.

Returns

True if not equal, otherwise false.

Exceptions

Does	not throw any exception.

operator==()

bool operator== ( const ZoomDescriptor & zoomDescriptor ) const

inlinenoexcept

Compares to an other zoom descriptor.

Parameters

[in]

zoomDescriptor

Other zoom descriptor.

Returns

True if equal, otherwise false.

Exceptions

Does	not throw any exception.