CartoType API
Public Types | Public Member Functions | Public Attributes
CartoType::TObjectStyle Class Reference

#include <cartotype_style_sheet.h>

List of all members.

Public Types

enum  { EForcedLevel = 0x8000, ERelativeForcedLevel = 0x4000, EForcedLevelValueMask = 0xF }

Public Member Functions

CT_IMPORT void Normalise ()
bool HasForcedLevels () const

Public Attributes

TPaint iPolygonFillPaint
TPaint iPolygonBorderPaint
TFixed iPolygonBorderWidth
TLineStyle iLineStyle
bool iDrawLabel
TLabelStyle iLabelStyle
int32 iLabelPriority
uint32 iForcedLevel
TBridgeStyle iBridgeStyle
TBridgeStyle iRampStyle
TTunnelStyle iTunnelStyle
const CIconiIcon
bool iIconCanOverlap
const CIconArrayiExtraIconArray
const CDashArrayiPolygonBorderDashArray
TFixed iMaxIntersectionDistance

Detailed Description

A style for a map object. All dimensions are in pixels. (Dimensions can be set in any convenient unit in the XML style sheet but are converted into pixels when the style sheet is read.)


Member Enumeration Documentation

anonymous enum

Bit values used in iForcedLevel.

Enumerator:
EForcedLevel 

Set if this is a forced level. If not the entire value is ignored and the ordinary level of the object is used.

ERelativeForcedLevel 

Set if the level is relative to the object's own level. If this bit is not set the forced level is absolute.

EForcedLevelValueMask 

A mask to select the signed value of the forced level.


Member Function Documentation

bool CartoType::TObjectStyle::HasForcedLevels ( ) const [inline]

Return true if this style forces the z-levels of any objects.

CT_EXPORT void TObjectStyle::Normalise ( )

Normalise the style after it has been set by the style sheet by modifying certain parameters to improve drawing.


Member Data Documentation

The style for bridge borders, shadows and end decorations.

True if labels are drawn.

If non-null, a pointer to an array of icons to be used if the icon is not big enough: for example, a series of highway shields. For compiled styles the icon array and the icons are owned by the CMap::CStyle object.

The forced z-level if any. This value is made up from flags indicating whether there is a forced level, and whether it is relative to the current level, and the signed value.

If non-null this member points to the icon to be drawn for point objects. For compiled styles the icon is owned by the CMap::CStyle object.

If true, the icon can overlap other icons and labels.

The label priority. An arbitrary number. Lower numbers are drawn first within any group of layers ending in a request to draw labels. The default priority is zero.

The style in which labels (street names, etc.) are drawn.

The line style.

The maximum distance from an object, in pixels, that is affected when an object is drawn. For example, when roads are drawn, points up to half the road width are drawn to. This value is used when deciding which objects intersect a given region and therefore must be drawn.

To set this value correctly, call Normalise after setting the other parameters.

If non-null, a pointer to the dash array used for drawing polygon borders.

The paint used for polygon borders. To suppress borders, use KTransparentBlack.

Width of polygon borders in pixels.

The paint used for filling polygon objects. To suppress filling, use KTransparentBlack.

The style for access ramp borders, shadows and end decorations.

The style for tunnels.


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