Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QGeoCameraCapabilities Class Reference

\inmodule QtLocation More...

#include <qgeocameracapabilities_p.h>

Collaboration diagram for QGeoCameraCapabilities:

Public Member Functions

 QGeoCameraCapabilities ()
 \qmlvaluetype cameraCapabilities \inqmlmodule QtLocation
 QGeoCameraCapabilities (const QGeoCameraCapabilities &other) noexcept
 Constructs a camera capabilities object from the contents of other.
 QGeoCameraCapabilities (QGeoCameraCapabilities &&other) noexcept=default
 ~QGeoCameraCapabilities ()
 Destroys this camera capabilities object.
QGeoCameraCapabilitiesoperator= (const QGeoCameraCapabilities &other) noexcept
 Assigns the contents of other to this camera capabilities object and returns a reference to this camera capabilities object.
void swap (QGeoCameraCapabilities &other) noexcept
void setTileSize (int tileSize)
int tileSize () const
void setMinimumZoomLevel (double minimumZoomLevel)
double minimumZoomLevel () const
double minimumZoomLevelAt256 () const
void setMaximumZoomLevel (double maximumZoomLevel)
double maximumZoomLevel () const
double maximumZoomLevelAt256 () const
void setSupportsBearing (bool supportsBearing)
 Sets whether the associated plugin can render a map when the camera has an arbitrary bearing to supportsBearing.
bool supportsBearing () const
 Returns whether the associated plugin can render a map when the camera has an arbitrary bearing.
void setSupportsRolling (bool supportsRolling)
 Sets whether the associated plugin can render a map when the camera is rolled to supportsRolling.
bool supportsRolling () const
 Returns whether the associated plugin can render a map when the camera is rolled.
void setSupportsTilting (bool supportsTilting)
 Sets whether the associated plugin can render a map when the camera is tilted to supportsTilting.
bool supportsTilting () const
 Returns whether the associated plugin can render a map when the camera is tilted.
void setMinimumTilt (double minimumTilt)
double minimumTilt () const
void setMaximumTilt (double maximumTilt)
double maximumTilt () const
void setMinimumFieldOfView (double minimumFieldOfView)
double minimumFieldOfView () const
void setMaximumFieldOfView (double maximumFieldOfView)
double maximumFieldOfView () const
void setOverzoomEnabled (bool overzoomEnabled)
 Sets whether overzooming is supported by the associated plugin.
bool overzoomEnabled () const
 Returns whether overzooming is supported by the associated plugin.
bool isValid () const
 Returns whether this instance of the class is considered "valid".

Properties

qreal minimumZoomLevel
 \qmlproperty real cameraCapabilities::minimumZoomLevel
qreal maximumZoomLevel
 \qmlproperty real cameraCapabilities::maximumZoomLevel
qreal minimumTilt
 \qmlproperty real cameraCapabilities::minimumTilt
qreal maximumTilt
 \qmlproperty real cameraCapabilities::maximumTilt
qreal minimumFieldOfView
 \qmlproperty real cameraCapabilities::minimumFieldOfView
qreal maximumFieldOfView
 \qmlproperty real cameraCapabilities::maximumFieldOfView

Friends

bool operator== (const QGeoCameraCapabilities &lhs, const QGeoCameraCapabilities &rhs) noexcept
bool operator!= (const QGeoCameraCapabilities &lhs, const QGeoCameraCapabilities &rhs) noexcept

Detailed Description

\inmodule QtLocation

Since
5.6

The QGeoCameraCapabilities class describes the limitations on camera settings imposed by a mapping plugin.

Different mapping plugins will support different ranges of zoom levels, and not all mapping plugins will be able to support, bearing, tilting and rolling of the camera.

This class describes what the plugin supports, and is used to restrict changes to the camera information associated with a \l QGeoMap such that the camera information stays within these limits.

Definition at line 28 of file qgeocameracapabilities_p.h.

Constructor & Destructor Documentation

◆ QGeoCameraCapabilities() [1/3]

QGeoCameraCapabilities::QGeoCameraCapabilities ( )

\qmlvaluetype cameraCapabilities \inqmlmodule QtLocation

Since
QtLocation 5.10

The cameraCapabilities type holds information about the camera capabilities for a specific map type.

This includes the map minimum and maximum zoom level, minimum and maximum tilt angle and minimum and maximum field of view.

Constructs a camera capabilities object.

Definition at line 88 of file qgeocameracapabilities.cpp.

◆ QGeoCameraCapabilities() [2/3]

QGeoCameraCapabilities::QGeoCameraCapabilities ( const QGeoCameraCapabilities & other)
defaultnoexcept

Constructs a camera capabilities object from the contents of other.

◆ QGeoCameraCapabilities() [3/3]

QGeoCameraCapabilities::QGeoCameraCapabilities ( QGeoCameraCapabilities && other)
defaultnoexcept

◆ ~QGeoCameraCapabilities()

QGeoCameraCapabilities::~QGeoCameraCapabilities ( )
default

Destroys this camera capabilities object.

Member Function Documentation

◆ isValid()

bool QGeoCameraCapabilities::isValid ( ) const

Returns whether this instance of the class is considered "valid".

To be valid, the instance must have had at least one capability set (to either true or false) using a set method, or copied from another instance (such as by the assignment operator).

Definition at line 137 of file qgeocameracapabilities.cpp.

◆ maximumFieldOfView()

double QGeoCameraCapabilities::maximumFieldOfView ( ) const

Definition at line 354 of file qgeocameracapabilities.cpp.

◆ maximumTilt()

double QGeoCameraCapabilities::maximumTilt ( ) const

Definition at line 304 of file qgeocameracapabilities.cpp.

◆ maximumZoomLevel()

double QGeoCameraCapabilities::maximumZoomLevel ( ) const

Definition at line 192 of file qgeocameracapabilities.cpp.

◆ maximumZoomLevelAt256()

double QGeoCameraCapabilities::maximumZoomLevelAt256 ( ) const

Definition at line 197 of file qgeocameracapabilities.cpp.

◆ minimumFieldOfView()

double QGeoCameraCapabilities::minimumFieldOfView ( ) const

Definition at line 329 of file qgeocameracapabilities.cpp.

◆ minimumTilt()

double QGeoCameraCapabilities::minimumTilt ( ) const

Definition at line 280 of file qgeocameracapabilities.cpp.

◆ minimumZoomLevel()

double QGeoCameraCapabilities::minimumZoomLevel ( ) const

Definition at line 161 of file qgeocameracapabilities.cpp.

◆ minimumZoomLevelAt256()

double QGeoCameraCapabilities::minimumZoomLevelAt256 ( ) const

Definition at line 166 of file qgeocameracapabilities.cpp.

◆ operator=()

QGeoCameraCapabilities & QGeoCameraCapabilities::operator= ( const QGeoCameraCapabilities & other)
noexcept

Assigns the contents of other to this camera capabilities object and returns a reference to this camera capabilities object.

Definition at line 105 of file qgeocameracapabilities.cpp.

◆ overzoomEnabled()

bool QGeoCameraCapabilities::overzoomEnabled ( ) const

Returns whether overzooming is supported by the associated plugin.

Since
5.9

Definition at line 383 of file qgeocameracapabilities.cpp.

◆ setMaximumFieldOfView()

void QGeoCameraCapabilities::setMaximumFieldOfView ( double maximumFieldOfView)

Definition at line 348 of file qgeocameracapabilities.cpp.

◆ setMaximumTilt()

void QGeoCameraCapabilities::setMaximumTilt ( double maximumTilt)

Definition at line 298 of file qgeocameracapabilities.cpp.

◆ setMaximumZoomLevel()

void QGeoCameraCapabilities::setMaximumZoomLevel ( double maximumZoomLevel)

Definition at line 186 of file qgeocameracapabilities.cpp.

◆ setMinimumFieldOfView()

void QGeoCameraCapabilities::setMinimumFieldOfView ( double minimumFieldOfView)

Definition at line 323 of file qgeocameracapabilities.cpp.

◆ setMinimumTilt()

void QGeoCameraCapabilities::setMinimumTilt ( double minimumTilt)

Definition at line 274 of file qgeocameracapabilities.cpp.

◆ setMinimumZoomLevel()

void QGeoCameraCapabilities::setMinimumZoomLevel ( double minimumZoomLevel)

Definition at line 155 of file qgeocameracapabilities.cpp.

◆ setOverzoomEnabled()

void QGeoCameraCapabilities::setOverzoomEnabled ( bool overzoomEnabled)

Sets whether overzooming is supported by the associated plugin.

Overzooming means that zoom levels outside the [minimumZL, maximumZL] range can be set, and if tiles aren't available for those zoom levels, either tiles from other zoom levels will be used, or nothing will be shown.

Set this value to false if the plugin is not capable of that. For example if using a mapping engine that always clamp the zoomLevel value, which may cause misalignment in case of stacked map elements.

Since
5.9

Definition at line 372 of file qgeocameracapabilities.cpp.

◆ setSupportsBearing()

void QGeoCameraCapabilities::setSupportsBearing ( bool supportsBearing)

Sets whether the associated plugin can render a map when the camera has an arbitrary bearing to supportsBearing.

Definition at line 208 of file qgeocameracapabilities.cpp.

◆ setSupportsRolling()

void QGeoCameraCapabilities::setSupportsRolling ( bool supportsRolling)

Sets whether the associated plugin can render a map when the camera is rolled to supportsRolling.

Definition at line 227 of file qgeocameracapabilities.cpp.

◆ setSupportsTilting()

void QGeoCameraCapabilities::setSupportsTilting ( bool supportsTilting)

Sets whether the associated plugin can render a map when the camera is tilted to supportsTilting.

Definition at line 246 of file qgeocameracapabilities.cpp.

◆ setTileSize()

void QGeoCameraCapabilities::setTileSize ( int tileSize)

Definition at line 119 of file qgeocameracapabilities.cpp.

◆ supportsBearing()

bool QGeoCameraCapabilities::supportsBearing ( ) const

Returns whether the associated plugin can render a map when the camera has an arbitrary bearing.

Definition at line 218 of file qgeocameracapabilities.cpp.

◆ supportsRolling()

bool QGeoCameraCapabilities::supportsRolling ( ) const

Returns whether the associated plugin can render a map when the camera is rolled.

Definition at line 237 of file qgeocameracapabilities.cpp.

◆ supportsTilting()

bool QGeoCameraCapabilities::supportsTilting ( ) const

Returns whether the associated plugin can render a map when the camera is tilted.

Definition at line 256 of file qgeocameracapabilities.cpp.

◆ swap()

void QGeoCameraCapabilities::swap ( QGeoCameraCapabilities & other)
inlinenoexcept

Definition at line 48 of file qgeocameracapabilities_p.h.

◆ tileSize()

int QGeoCameraCapabilities::tileSize ( ) const

Definition at line 126 of file qgeocameracapabilities.cpp.

◆ operator!=

bool operator!= ( const QGeoCameraCapabilities & lhs,
const QGeoCameraCapabilities & rhs )
friend

Definition at line 55 of file qgeocameracapabilities_p.h.

◆ operator==

bool operator== ( const QGeoCameraCapabilities & lhs,
const QGeoCameraCapabilities & rhs )
friend

Definition at line 50 of file qgeocameracapabilities_p.h.

Property Documentation

◆ maximumFieldOfView

qreal QGeoCameraCapabilities::maximumFieldOfView
read

\qmlproperty real cameraCapabilities::maximumFieldOfView

This read-only property holds the maximum available field of view with this map type.

the maximum field of view supported by the associated plugin.

The value is in degrees and is clamped against a [1, 179] range.

Since
5.9

Definition at line 37 of file qgeocameracapabilities_p.h.

◆ maximumTilt

qreal QGeoCameraCapabilities::maximumTilt
read

\qmlproperty real cameraCapabilities::maximumTilt

This read-only property holds the maximum available tilt with this map type.

the maximum tilt supported by the associated plugin.

The value is in degrees where 0 is equivalent to 90 degrees between the line of view and earth's surface, that is, looking straight down to earth.

Definition at line 35 of file qgeocameracapabilities_p.h.

◆ maximumZoomLevel

qreal QGeoCameraCapabilities::maximumZoomLevel
read

\qmlproperty real cameraCapabilities::maximumZoomLevel

This read-only property holds the maximum available zoom level with this map type.

the maximum zoom level supported by the associated plugin.

Larger values of the zoom level correspond to more detailed views of the map.

Definition at line 33 of file qgeocameracapabilities_p.h.

◆ minimumFieldOfView

qreal QGeoCameraCapabilities::minimumFieldOfView
read

\qmlproperty real cameraCapabilities::minimumFieldOfView

This read-only property holds the minimum available field of view with this map type.

the minimum field of view supported by the associated plugin.

The value is in degrees and is clamped against a [1, 179] range.

Since
5.9

Definition at line 36 of file qgeocameracapabilities_p.h.

◆ minimumTilt

qreal QGeoCameraCapabilities::minimumTilt
read

\qmlproperty real cameraCapabilities::minimumTilt

This read-only property holds the minimum available tilt with this map type.

the minimum tilt supported by the associated plugin.

The value is in degrees where 0 is equivalent to 90 degrees between the line of view and earth's surface, that is, looking straight down to earth.

Definition at line 34 of file qgeocameracapabilities_p.h.

◆ minimumZoomLevel

qreal QGeoCameraCapabilities::minimumZoomLevel
read

\qmlproperty real cameraCapabilities::minimumZoomLevel

This read-only property holds the minimum available zoom level with this map type.

the minimum zoom level supported by the associated plugin.

Larger values of the zoom level correspond to more detailed views of the map.

Definition at line 32 of file qgeocameracapabilities_p.h.


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