CartoType C++ API 7.8.2, 2022-03-25
for Windows, Linux, Qt and other platforms supporting C++ development
Public Member Functions | Public Attributes | List of all members
CartoType::TPerspectiveParam Class Reference

#include <cartotype_framework.h>

Public Member Functions

 TPerspectiveParam (const char *aText)
TResult ReadFromXml (const char *aText)
std::string ToXml () const
bool operator== (const TPerspectiveParam &aP) const
bool operator!= (const TPerspectiveParam &aP) const
bool operator< (const TPerspectiveParam &aP) const

Public Attributes

TPointFP iPositionDegrees
bool iAutoPosition = true
double iHeightInMeters = 0
double iAzimuthDegrees = 0
bool iAutoAzimuth = true
double iDeclinationDegrees = 30
double iRotationDegrees = 0
double iFieldOfViewDegrees = 22.5

Detailed Description

Parameters giving detailed control of the perspective view.

Constructor & Destructor Documentation

◆ TPerspectiveParam()

CartoType::TPerspectiveParam::TPerspectiveParam ( const char *  aText)

Reads a perspective parameter object from its XML form. Throws an exception if there is an error.

Member Function Documentation

◆ operator!=()

bool CartoType::TPerspectiveParam::operator!= ( const TPerspectiveParam aP) const

The inequality operator.

◆ operator<()

bool CartoType::TPerspectiveParam::operator< ( const TPerspectiveParam aP) const

The less-than operator.

◆ operator==()

bool CartoType::TPerspectiveParam::operator== ( const TPerspectiveParam aP) const

The equality operator.

◆ ReadFromXml()

TResult CartoType::TPerspectiveParam::ReadFromXml ( const char *  aText)

Reads a perspective parameter object from its XML form. Returns an error code; does not throw exceptions.

◆ ToXml()

std::string CartoType::TPerspectiveParam::ToXml ( ) const

Creates a string representing a perspective parameter object in XML.

Member Data Documentation

◆ iAutoAzimuth

bool CartoType::TPerspectiveParam::iAutoAzimuth = true

If true, ignore iAzimuthDegrees and use the current map orientation.

◆ iAutoPosition

bool CartoType::TPerspectiveParam::iAutoPosition = true

If true, ignore iPosition, and set the camera position so that the location in the center of the display is shown.

◆ iAzimuthDegrees

double CartoType::TPerspectiveParam::iAzimuthDegrees = 0

The azimuth of the camera in degrees going clockwise, where 0 is N, 90 is E, etc.

◆ iDeclinationDegrees

double CartoType::TPerspectiveParam::iDeclinationDegrees = 30

The declination of the camera downward from the horizontal plane. Values are clamped to the range -90...90.

◆ iFieldOfViewDegrees

double CartoType::TPerspectiveParam::iFieldOfViewDegrees = 22.5

The camera's field of view in degrees.

◆ iHeightInMeters

double CartoType::TPerspectiveParam::iHeightInMeters = 0

The height of the camera above the terrain. The value 0 causes a default value to be used, which is the width of the display.

◆ iPositionDegrees

TPointFP CartoType::TPerspectiveParam::iPositionDegrees

The position of the point on the terrain below the camera, in degrees longitude (x) and latitude (y).

◆ iRotationDegrees

double CartoType::TPerspectiveParam::iRotationDegrees = 0

The amount by which the camera is rotated about its axis, after applying the declination, in degrees going clockwise.

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