CartoType C++ API 8.8-7-gb35e4dc71
for Windows, Linux, Qt and other platforms supporting C++ development
Public Member Functions | Public Attributes | List of all members
CartoTypeCore::PerspectiveParam Class Reference

#include <cartotype_framework.h>

Public Member Functions

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

Public Attributes

PointFP PositionDegrees
 
bool AutoPosition = true
 
double HeightMeters = 0
 
double AzimuthDegrees = 0
 
bool AutoAzimuth = true
 
double DeclinationDegrees = 30
 
double RotationDegrees = 0
 
double FieldOfViewDegrees = 22.5
 

Detailed Description

Parameters giving detailed control of the perspective view.

Constructor & Destructor Documentation

◆ PerspectiveParam()

CartoTypeCore::PerspectiveParam::PerspectiveParam ( const char *  aText)
explicit

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

Member Function Documentation

◆ operator!=()

bool CartoTypeCore::PerspectiveParam::operator!= ( const PerspectiveParam aP) const
inline

The inequality operator.

◆ operator<()

bool CartoTypeCore::PerspectiveParam::operator< ( const PerspectiveParam aP) const
inline

The less-than operator.

◆ operator==()

bool CartoTypeCore::PerspectiveParam::operator== ( const PerspectiveParam aP) const
inline

The equality operator.

◆ ReadFromXml()

Result CartoTypeCore::PerspectiveParam::ReadFromXml ( const char *  aText)

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

◆ ToXml()

std::string CartoTypeCore::PerspectiveParam::ToXml ( ) const

Creates a string representing a perspective parameter object in XML.

Member Data Documentation

◆ AutoAzimuth

bool CartoTypeCore::PerspectiveParam::AutoAzimuth = true

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

◆ AutoPosition

bool CartoTypeCore::PerspectiveParam::AutoPosition = true

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

◆ AzimuthDegrees

double CartoTypeCore::PerspectiveParam::AzimuthDegrees = 0

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

◆ DeclinationDegrees

double CartoTypeCore::PerspectiveParam::DeclinationDegrees = 30

The declination of the camera downward from the horizontal plane. The value 90 is equivalent to looking straight downwards, and perspective is apparent only in 3D buildings. Values are clamped to the range 25...90 when creating the perspective transform. Smaller declinations cause performance problems and integer overflow in coordinate conversion.

◆ FieldOfViewDegrees

double CartoTypeCore::PerspectiveParam::FieldOfViewDegrees = 22.5

The camera's field of view in degrees.

◆ HeightMeters

double CartoTypeCore::PerspectiveParam::HeightMeters = 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.

◆ PositionDegrees

PointFP CartoTypeCore::PerspectiveParam::PositionDegrees

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

◆ RotationDegrees

double CartoTypeCore::PerspectiveParam::RotationDegrees = 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: