CartoTypeBase.h

Go to the documentation of this file.

/*
CartoTypeBase.h
Copyright 2011-2021 CartoType Ltd.
See www.cartotype.com for more information.
*/
 
#ifndef CartoTypeBase_h__
#define CartoTypeBase_h__
 
#import <Foundation/Foundation.h>
#import <CoreGraphics/CGImage.h>
#import <CoreGraphics/CGGeometry.h>
#import <CartoType/CartoTypeResultCode.h>
 
typedef enum
    {
    StringMatchPrefixFlag = 1,
    StringMatchIgnoreSymbolsFlag = 2,
    StringMatchFoldAccentsFlag = 4,
    StringMatchFuzzyFlag = 8,
    StringMatchFoldCaseFlag = 16,
    StringMatchIgnoreWhitespaceFlag = 32,
    
    StringMatchExact = 0,
    StringMatchFoldCase = StringMatchFoldCaseFlag,
    StringMatchPrefix = StringMatchPrefixFlag,
    StringMatchIgnoreNonAlphanumerics = StringMatchIgnoreSymbolsFlag | StringMatchIgnoreWhitespaceFlag,
    StringMatchLoose = StringMatchIgnoreNonAlphanumerics | StringMatchFoldAccentsFlag | StringMatchFoldCaseFlag,
    StringMatchFuzzy = StringMatchIgnoreNonAlphanumerics | StringMatchFoldAccentsFlag | StringMatchFuzzyFlag | StringMatchFoldCaseFlag
    } CartoTypeStringMatchMethod;
 
typedef enum
    {
    PngFileType,
    JpegFileType,
    TiffFileType,
    Ctm1FileType,
    CtmsFileType,
    KmlFileType,
    CtsqlFileType,
    CartoTypeRouteFileType,
    GpxFileType
    } CartoTypeFileType;
 
typedef enum
    {
    PointMapObjectType,
    
    LineMapObjectType,
    
    PolygonMapObjectType,
    
    ArrayMapObjectType,
    
    MapObjectTypes,
    
    NoMapObjectType = -1
    
    } CartoTypeMapObjectType;
 
typedef enum
    {
    OnCurvePointType = 0,
    QuadraticPointType = 1,
    CubicPointType = 2
    } CartoTypePointType;
 
typedef enum
    {
    AlignCenter,
    AlignStandard,
    AlignReverse,
    AlignLeft,
    AlignRight
    } CartoTypeAlign;
 
typedef struct
    {
    int32_t x;
    int32_t y;
    CartoTypePointType type;
    } CartoTypePathPoint;
 
typedef struct
    {
    double x;
    double y;
    CartoTypePointType type;
    } CartoTypePathPointFP;
 
typedef struct
    {
    double x;
    double y;
    } CartoTypePoint;
 
typedef struct
    {
    double x_min;
    double y_min;
    double x_max;
    double y_max;
    } CartoTypeRect;
 
typedef struct
    {
    CartoTypePoint point;
    CTResult result;
    } CartoTypePointAndResult;
    
typedef struct
    {
    CartoTypeRect rect;
    CTResult result;
    } CartoTypeRectAndResult;
   
@class CartoTypeGeometry; // forward declaration
 
@interface CartoTypeGeometryAndResult: NSObject
    @property (nonatomic, strong) CartoTypeGeometry* geometry;
    @property (nonatomic) CTResult result;
@end
 
typedef struct
    {
    uint64_t objectId;
    CTResult result;
    } CartoTypeIdAndResult;
    
typedef struct
    {
    double area;
    double length;
    CTResult result;
    } CartoTypeAreaLengthAndResult;
 
typedef enum
    {
    DegreeCoordType,
    DisplayCoordType,
    ScreenCoordType = DisplayCoordType,
    MapCoordType,
    MapMeterCoordType
    } CartoTypeCoordType;
    
typedef uint32_t CartoTypeColor;
 
enum
    {
    CTBlack = 0xFF000000,
    CTDarkGray = 0xFF555555,
    CTDarkRed = 0xFF000080,
    CTDarkGreen = 0xFF008000,
    CTDarkYellow = 0xFF008080,
    CTDarkBlue = 0xFF800000,
    CTDarkMagenta = 0xFF800080,
    CTDarkCyan = 0xFF808000,
    CTRed = 0xFF0000FF,
    CTGreen = 0xFF00FF00,
    CTYellow = 0xFF00FFFF,
    CTBlue = 0xFFFF0000,
    CTMagenta = 0xFFFF00FF,
    CTCyan = 0xFFFFFF00,
    CTGray = 0xFFAAAAAA,
    CTWhite = 0xFFFFFFFF,
 
    CTTransparentBlack = 0x00000000
    };
    
@interface CartoTypeBlendStyle: NSObject
    @property (nonatomic) NSString* styles;
    @property (nonatomic) CartoTypeColor mainColor;
    @property (nonatomic) CartoTypeColor borderColor;
    @property (nonatomic) CartoTypeColor textColor;
    @property (nonatomic) CartoTypeColor textGlowColor;
    @property (nonatomic) CartoTypeColor iconColor;
    
    -(id)initWithBlendStyle:(void*)aBlendStyle;
    -(const void*)blendStyle;
@end
 
@interface CartoTypeMapObjectParam: NSObject
    -(id)initWithType:(CartoTypeMapObjectType)aType andLayer:(NSString*)aLayer andCoordType:(CartoTypeCoordType)aCoordType;
    -(void)dealloc;
    -(void)appendX:(double)aX andY:(double)aY;
    -(void)appendX:(double)aX andY:(double)aY andPointType:(CartoTypePointType)aPointType;
    -(void)beginContour;
    -(void*)getGeometry;
 
    @property (nonatomic) uint32_t mapHandle;
    @property (nonatomic, strong) NSString* layer;
    @property (nonatomic) double radius;
    @property (nonatomic) CartoTypeCoordType radiusCoordType;
    @property (nonatomic) uint32_t intAttrib;
    @property (nonatomic, strong) NSString* stringAttrib;
    @property (nonatomic) uint64_t objectId;
    @property (nonatomic) bool replace;
@end
 
@interface CartoTypeAddress: NSObject
    @property (nonatomic, strong) NSString* building;
    @property (nonatomic, strong) NSString* feature;
    @property (nonatomic, strong) NSString* street;
    @property (nonatomic, strong) NSString* subLocality;
    @property (nonatomic, strong) NSString* locality;
    @property (nonatomic, strong) NSString* island;
    @property (nonatomic, strong) NSString* subAdminArea;
    @property (nonatomic, strong) NSString* adminArea;
    @property (nonatomic, strong) NSString* country;
    @property (nonatomic, strong) NSString* postCode;
    -(NSString*)ToString:(bool) aFull;
    @end
 
typedef enum
    {
    AddressPartBuilding,
    AddressPartFeature,
    AddressPartStreet,
    AddressPartSubLocality,
    AddressPartLocality,
    AddressPartIsland,
    AddressPartSubAdminArea,
    AddressPartAdminArea,
    AddressPartCountry,
    AddressPartPostCode
    } CartoTypeAddressPart;
 
@protocol CartoTypePath
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
@end
 
@interface CartoTypeMatch: NSObject
    @property (nonatomic, strong) NSString* key;
    @property (nonatomic, strong) NSString* value;
    @property (nonatomic) size_t start;
    @property (nonatomic) size_t end;
@end
 
@interface CartoTypeMapObject: NSObject <CartoTypePath>
    -(id)initWithMapObject:(void*)aMapObject;
    -(void)dealloc;
    -(CartoTypeMapObjectType)getType;
    -(NSString*)getLayerName;
    -(NSString*)getLabel;
    -(NSString*)getStringAttribute:(NSString*)aAttribName;
    -(NSMutableDictionary*)getStringAttributes;
    -(int32_t)getIntAttribute;
    -(CartoTypePoint)getCenter;
    
    -(CartoTypeRect)getBounds;
 
    -(CartoTypePointAndResult)getCenterInDegrees;
 
    -(CartoTypeRectAndResult)getBoundsInDegrees;
    
    -(CartoTypeGeometryAndResult*)getGeometryInDegrees;
    -(CTResult)getMatch:(CartoTypeMatch*)aMatch text:(NSString*)aText matchMethod:(CartoTypeStringMatchMethod)aMethod attributes:(NSString*)aAttributes phrase:(bool)aPhrase;
    -(uint64_t)getObjectId;
    -(int)contourCount;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPoint)point:(int)aContourIndex pointIndex:(int)aPointIndex;
 
    -(void*)getObject;
@end
 
@interface CartoTypeMapObjectGroup: NSObject
    -(id)initWithMapObjectGroup:(void*)aMapObjectGroup;
    @property (nonatomic, strong) NSString* name;
    @property (nonatomic, strong) NSMutableArray* objectArray;
@end
 
typedef enum
    {
    PathIntersectionTypeUnknown,
    PathIntersectionTypeSeparate,
    /* The paths intersect or are identical. */
    PathIntersectionTypeIntersects,
    PathIntersectionTypeContains,
    PathIntersectionTypeContained
    } CartoTypePathIntersectionType;
 
@interface CartoTypePathIntersectionInfo: NSObject
    @property (nonatomic) CartoTypePathIntersectionType type;
    @property (nonatomic) double distance;
    @property (nonatomic) CartoTypePoint nearest1;
    @property (nonatomic) CartoTypePoint nearest2;
 
    -(void*)getPointer;
@end
 
typedef enum
    {
    IntersectionClipOperation,
    UnionClipOperation,
    DifferenceClipOperation,
    XorClipOperation
    }  CartoTypeClipOperation;
 
@interface CartoTypeGeometry: NSObject
    -(id)initWithCoordType:(CartoTypeCoordType)aCoordType;
    -(id)initWithMapObject:(CartoTypeMapObject*)aMapObject;
    -(id)initWithGeometryContour:(CartoTypeGeometry*)aGeometry contourIndex:(int)aContourIndex;
    -(id)initWithRect:(CartoTypeRect)aRect coordType:(CartoTypeCoordType)aCoordType;
    -(void)dealloc;
    -(CartoTypeCoordType)coordType;
    -(void)appendX:(double)aX andY:(double)aY;
    -(void)appendX:(double)aX andY:(double)aY andPointType:(CartoTypePointType)aPointType;
    -(void)beginContour;
    -(int)contourCount;
    -(bool)contourIsOuter:(int)aContourIndex;
    -(int)pointCount:(int)aContourIndex;
    -(CartoTypePathPointFP)point:(int)aContourIndex pointIndex:(int)aPointIndex;
    -(bool)isEmpty;
    -(bool)isClosed;
    -(void)setClosed:(bool)aClosed;
    -(void)reverse;
    -(CartoTypePathIntersectionType)intersectionType:(CartoTypeMapObject*)aMapObject;
    -(CartoTypePathIntersectionInfo*)intersectionInfo:(CartoTypeMapObject*)aMapObject;
    -(NSArray<NSNumber*>*)intersectionTypes:(NSArray<CartoTypeMapObjectGroup*>*)aMapObjectArray;
    -(NSArray<CartoTypePathIntersectionInfo*>*)intersectionInfos:(NSArray<CartoTypeMapObjectGroup*>*)aMapObjectArray;
    -(bool) intersects:(CartoTypeMapObject*)aMapObject;
    -(bool) contains:(CartoTypeMapObject*)aMapObject;
    -(bool) contained:(CartoTypeMapObject*)aMapObject;
    -(CartoTypeGeometry*) clip:(CartoTypeClipOperation)aClipOperation mapObject:(CartoTypeMapObject*)aMapObject;
    -(NSArray<CartoTypeGeometry*>*) clip:(CartoTypeClipOperation)aClipOperation mapObjects:(NSArray<CartoTypeMapObjectGroup*>*)aMapObjectArray;
    +(CartoTypeGeometry*) envelope:(CartoTypeMapObject*)aMapObject offsetInMeters:(double)aOffsetInMeters;
 
    -(id)initWithGeometry:(void*)aGeometry;
    -(void*)getGeometry;
@end
 
typedef enum
    {
    POINone,           
    POIAirport,        
    POIBar,            
    POIBeach,          
    POIBusStation,     
    POICafe,           
    POICamping,        
    POIFastFood,       
    POIFuel,           
    POIGolfCourse,     
    POIHospital,       
    POIHotel,          
    POIPharmacy,       
    POIPolice,         
    POIRestaurant,     
    POIShops,          
    POISportsCenter,   
    POISupermarket,    
    POISwimmingPool,   
    POITourism,        
    POITrainStation    
    } CartoTypePointOfInterestType;
 
@interface CartoTypeFindParam: NSObject
    -(id)init;
    -(id)initWithPOIType:(CartoTypePointOfInterestType)aPOIType text:(NSString*)aText location:(CartoTypeGeometry*)aLocation;
 
    @property (nonatomic) int maxObjectCount;
    @property (nonatomic) CartoTypeGeometry* clip;
    @property (nonatomic) CartoTypeGeometry* location;
    @property (nonatomic, strong) NSString* layers;
    @property (nonatomic, strong) NSString* attributes;
    @property (nonatomic, strong) NSString* text;
    @property (nonatomic) CartoTypeStringMatchMethod stringMatchMethod;
    @property (nonatomic, strong) NSString* condition;
    @property (nonatomic) bool merge;
    @property (nonatomic) double timeOut;
@end
 
typedef enum
    {
    MemoryWritableMapType,
    SQLiteWritableMapType
    } CartoTypeWritableMapType;
 
typedef enum
    {
    NoticePositionTopLeft,
    NoticePositionTopRight,
    NoticePositionBottomLeft,
    NoticePositionBottomRight,
    NoticePositionTop,
    NoticePositionRight,
    NoticePositionLeft,
    NoticePositionBottom,
    NoticePositionCenter
    } CartoTypeNoticePosition;
 
@interface CartoTypeExtendedNoticePosition: NSObject
    -(id)init:(CartoTypeNoticePosition)aPosition xInset:(double)aXInset xUnit:(NSString*)aXUnit yInset:(double)aYInset yUnit:(NSString*)aYUnit;
    -(void*)getPosition;
@end
 
@interface CartoTypePositionedBitmap: NSObject
    -(id)init:(CGImageRef)aImage topLeft:(CGPoint)aTopLeft;
    -(void)dealloc;
    @property (nonatomic) CGImageRef image;
    @property (nonatomic) CGPoint topLeft;
@end
 
@interface CartoTypePerspectiveParam: NSObject
    -(CTResult)readFromXml:(NSString*)aText;
    -(NSString*)toXml;
    @property (nonatomic) CartoTypePoint positionDegrees;
    @property (nonatomic) bool autoPosition;
    @property (nonatomic) double heightInMeters;
    @property (nonatomic) double azimuthDegrees;
    @property (nonatomic) bool autoAzimuth;
    @property (nonatomic) double declinationDegrees;
    @property (nonatomic) double rotationDegrees;
    @property (nonatomic) double fieldOfViewDegrees;
    -(void*)getPerspectiveParam;
@end
 
@interface CartoTypeViewState: NSObject
    -(CTResult)readFromXml:(NSString*)aText;
    -(NSString*)toXml;
    @property (nonatomic) int widthInPixels;
    @property (nonatomic) int heightInPixels;
    @property (nonatomic) CartoTypePoint viewCenterDegrees;
    @property (nonatomic) double scaleDenominator;
    @property (nonatomic) double rotationDegrees;
    @property (nonatomic) bool perspective;
    -(CartoTypePerspectiveParam*)getPerspectiveParam;
    -(void)setPerspectiveParam:(CartoTypePerspectiveParam*)aPerspectiveParam;
    -(void*)getViewState;
@end
 
typedef enum
    {
    LetterCaseNone,
    LetterCaseLower,
    LetterCaseUpper,
    LetterCaseTitle
    } CartoTypeLetterCase;
    
/* Identifiers of tables in CTM1 map files. */
 
static const uint16_t KGlobalTable = 0;
static const uint16_t KLayerTable = 1;
static const uint16_t KTable2Obsolete = 2;
static const uint16_t KTable3Obsolete = 3;
static const uint16_t KProjectionTable = 4;
static const uint16_t KStringTable = 5;
static const uint16_t KLowResolutionLayerTable = 6;
static const uint16_t KPaletteTable = 7;
static const uint16_t KTextIndexTable = 8;
static const uint16_t KTable9Obsolete = 9;
static const uint16_t KRouteTableAStar = 10;
static const uint16_t KRouteTableCH = 11;
static const uint16_t KRouteTableExtra = 12;
static const uint16_t KRouteTableTurnExpanded = 13;
static const uint16_t KRouteTableCHStandAlone = 14;
static const uint16_t KRouteTableTECH = 15;
static const uint16_t KRouteTableCHTiled = 16;
static const uint16_t KRouteTableTECHTiled = 17;
static const uint16_t KRouteTableTurnExpandedCompact = 18;
static const uint16_t KNoTable = UINT16_MAX;
 
typedef enum
    {
    PointFormatUnknown = 0,
 
    PointFormatMeter = 2,
 
    PointFormatScaledDegree = 7,
 
    PointFormatMeter32nds = 8
    } CartoTypePointFormat;
 
@interface CartoTypeMapMetaData: NSObject
    @property (nonatomic) int fileVersionMajor;
    @property (nonatomic) int fileVersionMinor;
    @property (nonatomic) int cartoTypeVersionMajor;
    @property (nonatomic) int cartoTypeVersionMinor;
    @property (nonatomic) int cartoTypeBuild;
    @property (nonatomic) NSString* dataSetName;
    @property (nonatomic) NSString* copyright;
    @property (nonatomic) NSString* projectionName;
    @property (nonatomic) NSString* projectionParameters;
    @property (nonatomic) CartoTypePointFormat pointFormat;
    @property (nonatomic) CartoTypeRect extentInMapCoords;
    @property (nonatomic) CartoTypeRect extentInDegrees;
    @property (nonatomic) int routeTableType;
    @property (nonatomic) bool routeDataHasGradients;
    @property (nonatomic) bool largeFile;
    @property (nonatomic) bool drivingSideKnown;
    @property (nonatomic) bool driveOnLeft;
    
    -(id)initWithMetaData:(void*)aMetaData;
    -(const void*)metaData;
@end
 
#endif