CtViewState Class Reference

#import <CartoTypeBase.h>

Inheritance diagram for CtViewState:

Instance Methods
(CtResult)	- readFromXml:
(NSString *)	- toXml
(CtPerspectiveParam *)	- getPerspectiveParam
(void)	- setPerspectiveParam:
(void *)	- viewState

Properties
int	widthInPixels
int	heightInPixels
CtPoint	viewCenterDegrees
double	scaleDenominator
double	rotationDegrees
bool	perspective

Detailed Description

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

Method Documentation

getPerspectiveParam

- (CtPerspectiveParam *) getPerspectiveParam

Gets a copy of the parameters to be used for perspective mode.

readFromXml:

- (CtResult) readFromXml:

(NSString *)

aText

Reads a view state from its XML form.

setPerspectiveParam:

- (void) setPerspectiveParam:

(CtPerspectiveParam *)

aPerspectiveParam

Sets the parameters to be used for perspective mode.

toXml

- (NSString *) toXml

Creates a string representing a view state in XML.

viewState

- (void *) viewState

(for internal use) Gets a pointer to the underlying C++ object.

Property Documentation

heightInPixels

- (int) heightInPixels

readwritenonatomicassign

The display height in pixels.

perspective

- (bool) perspective

readwritenonatomicassign

True if perspective mode is on.

rotationDegrees

- (double) rotationDegrees

readwritenonatomicassign

The clockwise rotation of the view in degrees.

scaleDenominator

- (double) scaleDenominator

readwritenonatomicassign

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

viewCenterDegrees

- (CtPoint) viewCenterDegrees

readwritenonatomicassign

The view center in map coordinates.

widthInPixels

- (int) widthInPixels

readwritenonatomicassign

The display width in pixels.

---

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

• CartoTypeBase.h