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::ViewState Class Reference

#include <cartotype_framework.h>

Public Member Functions

 ViewState (const char *aXmlText)
 
Result ReadFromXml (const char *aXmlText)
 
bool operator== (const ViewState &aOther) const
 
bool operator< (const ViewState &aOther) const
 
bool operator!= (const ViewState &aOther) const
 
std::string ToXml () const
 

Public Attributes

int32_t WidthInPixels = 256
 
int32_t HeightInPixels = 256
 
PointFP ViewCenterDegrees
 
double ScaleDenominator = 0
 
double RotationDegrees = 0
 
bool Perspective = false
 
CartoTypeCore::PerspectiveParam PerspectiveParam
 

Detailed Description

The view state, which can be retrieved or set so that maps can be recreated.

Constructor & Destructor Documentation

◆ ViewState()

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

Reads a view state object from its XML form.

Member Function Documentation

◆ operator!=()

bool CartoTypeCore::ViewState::operator!= ( const ViewState aOther) const
inline

The inequality operator.

◆ operator<()

bool CartoTypeCore::ViewState::operator< ( const ViewState aOther) const

The less-than operator.

◆ operator==()

bool CartoTypeCore::ViewState::operator== ( const ViewState aOther) const

The equality operator.

◆ ReadFromXml()

Result CartoTypeCore::ViewState::ReadFromXml ( const char *  aXmlText)

Reads a view state object from its XML form.

◆ ToXml()

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

Creates a string representing a view state in XML.

Member Data Documentation

◆ HeightInPixels

int32_t CartoTypeCore::ViewState::HeightInPixels = 256

The display height in pixels.

◆ Perspective

bool CartoTypeCore::ViewState::Perspective = false

True if perspective mode is on.

◆ PerspectiveParam

CartoTypeCore::PerspectiveParam CartoTypeCore::ViewState::PerspectiveParam

The parameters to be used for perspective mode.

◆ RotationDegrees

double CartoTypeCore::ViewState::RotationDegrees = 0

The clockwise rotation of the view in degrees.

◆ ScaleDenominator

double CartoTypeCore::ViewState::ScaleDenominator = 0

The denominator of the scale fraction; e.g., 50000 for 1:50000.

◆ ViewCenterDegrees

PointFP CartoTypeCore::ViewState::ViewCenterDegrees

The view center in degrees longitude (x) and latitude (y).

◆ WidthInPixels

int32_t CartoTypeCore::ViewState::WidthInPixels = 256

The display width in pixels.


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