CartoTypeFramework.h

Go to the documentation of this file.

/*
CartoTypeFramework.h
Copyright 2013-2025 CartoType Ltd.
See www.cartotype.com for more information.
*/
 
#import <CartoType/CartoTypeBase.h>
#import <CartoType/CartoTypeRouter.h>
#import <CartoType/CartoTypeResultCode.h>
#import <CartoType/CartoTypeFrameworkParam.h>
#import <CartoType/CartoTypeLegend.h>



@protocol CtFindAsyncProtocol <NSObject>
    -(void)handler:(NSMutableArray<CtMapObject*>*)aObjectArray;
@end
@protocol CartoTypeFindAsyncProtocol <CtFindAsyncProtocol>
@end

@protocol CtFindAsyncGroupProtocol <NSObject>
    -(void)handler:(NSMutableArray<CtMapObjectGroup*>*)aObjectGroupArray;
@end
@protocol CartoTypeFindAsyncGroupProtocol <CtFindAsyncGroupProtocol>
@end

@protocol CtCreateRouteAsyncProtocol <NSObject>
    -(void)handler:(CtResult)aResult route:(CtRoute*)aRoute;
@end
@protocol CartoTypeCreateRouteAsyncProtocol <CtCreateRouteAsyncProtocol>
@end

@protocol CtLoadMapAsyncProtocol <NSObject>
    -(void)handler:(CtResult)aResult filename:(NSString*)aFileName key:(NSString*)aKey;
@end
@protocol CartoTypeLoadMapAsyncProtocol <CtLoadMapAsyncProtocol>
@end

@interface CtFramework: NSObject

-(id)initWithMap:(NSString*)aMapFileName andStyle:(NSString*)aStyleSheetFileName andFont:(NSString*)aFontFileName andWidth:(int)aWidth andHeight:(int)aHeight;

-(id)initWithParam:(CtFrameworkParam*)aParam;

-(CtResult)lastError;

-(void*)framework;

-(id)copy;

-(CtResult)configure:(NSString*)aConfigFileName;

+(NSString*)description;

+(NSString*)version;

+(NSString*)build;

-(CtResult)license:(NSString*)aKey;

-(CtResult)setProviderParam:(NSString*)aKey value:(NSString*)aValue;

@property (nonatomic) NSString* licensee;

@property (nonatomic) NSString* expiryDate;

@property (nonatomic) NSString* appBuildDate;

@property (nonatomic) NSString* copyright;

-(CtResult)setCopyrightNotice;

-(CtResult)setCopyrightNotice:(NSString*)aCopyright;

-(CtResult)setLegend:(CtNoticePosition*)aPosition legend:(CtLegend*)aLegend;

-(CtResult)setLegend:(CtNoticeAnchor)aAnchor width:(double)aWidth unit:(NSString*)aUnit;

@property (nonatomic) bool legendEnabled;

-(CtResult)setScaleBar:(CtNoticePosition*)aPosition legend:(CtLegend*)aLegend;

-(CtResult)setScaleBar:(CtNoticeAnchor)aAnchor width:(double)aWidth unit:(NSString*)aUnit;

@property (nonatomic) bool scaleBarEnabled;

-(CtResult)setTurnInstructions:(CtNoticePosition*)aPosition legend:(CtLegend*)aLegend abbreviate:(bool)aAbbreviate;

-(CtResult)setTurnInstructions:(CtNoticeAnchor)aAnchor width:(double)aWidth widthUnit:(NSString*)aWidthUnit textSize:(double)aTextSize textSizeUnit:(NSString*)aTextSizeUnit abbreviate:(bool)aAbbreviate;

@property (nonatomic) bool turnInstructionsEnabled;

-(void)setTurnInstructionText:(NSString*)aText;

-(NSString*)turnInstructionText;

-(void)drawNoticesAutomatically:(bool)aEnable;

@property (nonatomic) bool hasNotices;

-(CtPositionedBitmap*)noticeBitmap;

-(CtResult)loadMap:(NSString*)aMapFileName;

-(CtResult)loadMapAsync:(id<CtLoadMapAsyncProtocol>)aCallback filename:(NSString*)aMapFileName key:(NSString*)aKey;

-(CtResult)loadMapsAutomatically:(CtTileParam*)aTileParam;

-(CtResult)unloadMapByHandle:(uint32_t)aHandle;

-(CtResult)createWritableMapOfType:(CtWritableMapType)aType;

-(CtResult)saveMap:(uint32_t)aHandle fileName:(NSString*)aFileName fileType:(CtFileType)aFileType;

-(CtResult)readMap:(uint32_t)aHandle fileName:(NSString*)aFileName fileType:(CtFileType)aFileType;

-(NSData*)saveMap:(uint32_t)aHandle param:(CtFindParam*)aFindParam;

-(CtResult)readMap:(uint32_t)aHandle data:(NSData*)aData;

-(CtResult)writeMapImage:(NSString*)aFileName fileType:(CtFileType)aFileType compress:(bool)aCompress;

-(bool)mapIsEmpty:(uint32_t)aHandle;

-(void)enableMap:(uint32_t)aHandle;

-(void)disableMap:(uint32_t)aHandle;

@property (nonatomic) uint32_t lastMapHandle;

@property (nonatomic) uint32_t mainMapHandle;

@property (nonatomic) uint32_t memoryMapHandle;

@property (nonatomic) size_t mapCount;

-(CtMapMetaData*)mapMetaData:(uint32_t)aIndex;

-(CtResult)loadFont:(NSString*)aFontFileName;

-(CtResult)setStyleSheet:(NSString*)aStyleSheetFileName;

-(CtResult)reloadStyleSheet;

-(CtResult)setMapWidth:(int)aWidth andHeight:(int)aHeight;

@property (nonatomic) double resolutionDpi;

@property (nonatomic) double scaleDenominator;

@property (nonatomic) double scaleDenominatorInView;

-(double)scaleDenominatorFromZoomLevel:(double)aZoomLevel forImageSize:(int)aImageSizeInPixels;

-(double)zoomLevelFromScaleDenominator:(double)aScaleDenominator forImageSize:(int)aImageSizeInPixels;

-(double)distanceInMetersFrom:(CtPoint)aStart to:(CtPoint)aEnd coordType:(CtCoordType)aCoordType;

@property (nonatomic) bool perspective;

@property (nonatomic) CtPerspectiveParam* perspectiveParam;

@property (nonatomic) bool draw3DBuildings;

@property (nonatomic) bool animateTransitions;

@property (nonatomic) double labelFPS;

@property (nonatomic) bool fixedLabels;

@property (nonatomic) double labelUpAngle;

-(CtResult)zoom:(double)aZoomFactor;

-(CtResult)zoomAt:(double)aZoomFactor x:(double)aX y:(double)aY coordType:(CtCoordType)aCoordType;

-(CtResult)rotate:(double)aAngle;

-(CtResult)rotateAt:(double)aAngle x:(double)aX y:(double)aY coordType:(CtCoordType)aCoordType;

-(CtResult)setRotationAt:(double)aAngle x:(double)aX y:(double)aY coordType:(CtCoordType)aCoordType;

@property (nonatomic) double rotation;

-(CtResult)panX:(int)aDx andY:(int)aDy;

-(CtResult)panFrom:(CtPoint)aFrom fromCoordType:(CtCoordType)aFromCoordType to:(CtPoint)aTo toCoordType:(CtCoordType) aToCoordType;

-(CtResult)setViewCenter:(CtPoint)aCenter coordType:(CtCoordType)aCoordType;

-(CtResult)setView:(CtRect)aView coordType:(CtCoordType)aCoordType margin:(int)aMarginInPixels minScale:(int)aMinScaleDenominator;

-(CtResult)setView:(CtGeometry*)aGeometry margin:(int)aMarginInPixels minScale:(int)aMinScaleDenominator;

-(CtResult)setViewToRoute:(int)aMarginInPixels minScale:(int)aMinScaleDenominator;

-(CtResult)setViewToWholeMap;

-(CtResult)setViewLimitsToMinScale:(double)aMinScaleDenominator maxScale:(double)aMaxScaleDenominator panArea:(CtGeometry*)aPanArea;

-(CtResult)setViewObject:(CtMapObject*)aMapObject margin:(int)aMarginInPixels minScale:(int)aMinScaleDenominator;

-(CtResult)setViewObjects:(NSArray<CtMapObject*>*)aObjectArray margin:(int)aMarginInPixels minScale:(int)aMinScaleDenominator;

-(CtResult)getView:(CtRect*)aView coordType:(CtCoordType)aCoordType;

@property (nonatomic) CtViewState* viewState;

-(CtResult)getMapExtent:(CtRect*)aExtent coordType:(CtCoordType)aCoordType;

@property (nonatomic) NSString* projectionAsProj4Param;

-(CtResult)insertMapObject:(CtMapObjectParam*)aParam;

-(CtIdAndResult)insertPushPin:(CtPoint)aPoint coordType:(CtCoordType)aCoordType stringAttrib:(NSString*)aStringAttrib color:(NSString*)aColor iconChar:(int)aIconCharacter id:(uint64_t)aId;

-(CtIdAndResult)insertCopyOfMapObject:(CtMapObject*)aObject map:(uint32_t)aMapHandle layerName:(NSString*)aLayerName radius:(double)aRadius radiusCoordType:(CtCoordType)aRadiusCoordType id:(uint64_t)aId replace:(bool)aReplace;

-(uint64_t)deleteObjectsFromMap:(uint32_t)aMapHandle fromID:(uint64_t)aStartID toID:(uint64_t)aEndId withCondition:(NSString*)aCondition;

-(CtMapObject*)loadMapObjectFromMap:(uint32_t)aMapHandle withID:(uint64_t)aObjectId;

-(CtResult)readGpx:(uint32_t)aMapHandle file:(NSString*)aFileName;

-(CtGeometry*)range:(CtRouteProfile*)aProfile point:(CtPoint)aPoint coordType:(CtCoordType)aCoordType timeOrDistance:(double)aTimeOrDistance isTime:(bool)aIsTime;

-(CtTimeAndDistanceMatrix*)timeAndDistanceMatrix:(CtPointSet*)aFrom to:(CtPointSet*)aTo;

-(bool)mutuallyAccessible:(NSMutableArray<NSNumber*>*)aPointArray coordType:(CtCoordType)aCoordType groupArray:(NSMutableArray<NSNumber*>*)aGroupArray;

-(void)enableLayer:(NSString*)aLayerName;

-(void)disableLayer:(NSString*)aLayerName;

-(bool)layerIsEnabled:(NSString*)aLayerName;

-(NSMutableArray<NSString*>*)layerNames;

-(CtResult)convertCoords:(CtGeometry*)aGeometry to:(CtCoordType)aToCoordType;

-(CtPointAndResult)convertPoint:(CtPoint)aPoint from:(CtCoordType)aFromCoordType to:(CtCoordType)aToCoordType;

@property (nonatomic) NSString* dataSetName;

-(double)pixelsToMeters:(double)aPixels;

-(double)metersToPixels:(double)aMeters;

-(CtResult)editSetWritableMap:(uint32_t)aMapHandle;

-(CtResult)editNewLineObject:(CtPoint)aDisplayPoint;

-(CtResult)editNewPolygonObject:(CtPoint)aDisplayPoint;

-(CtResult)editMoveCurrentPoint:(CtPoint)aDisplayPoint;
    
-(CtResult)editAddCurrentPoint;

-(CtResult)editDeleteCurrentPoint;

-(CtResult)editDeleteCurrentObject;

-(CtResult)editSelectNearestPoint:(CtPoint)aDisplayPoint radius:(double)aRadiusInMillimeters;

-(CtIdAndResult)editInsertCurrentObjectInLayer:(NSString*)aLayer id:(uint64_t)aId replace:(bool)aReplace;

-(CtResult)editSetCurrentObjectStringAttribute:(NSString*)aKey value:(NSString*)aValue;

-(CtResult)editSetCurrentObjectFeatureInfo:(CtFeatureInfo*)aFeatureInfo;

-(CtAreaLengthAndResult)editGetCurrentObjectAreaAndLength;

-(UIImage*)mapBitmap;

-(UIImage*)tileBitmapWithSize:(int)aSize andZoom:(int)aZoom andX:(int)aX andY:(int)aY;

-(bool)clipBackgroundToMapBounds:(bool)aEnable;

-(int)setTileOverSizeZoomLevels:(int)aLevels;

-(CtResult)loadIcon:(NSString*)aFileName id:(NSString*)aId hotSpot:(CtPoint)aHotSpot labelPos:(CtPoint)aLabelPos labelMaxlength:(int)aLabelMaxLength;

-(CtResult)find:(NSMutableArray<CtMapObject*>*)aObjectArray withParam:(CtFindParam*)aFindParam;

-(CtResult)findAsync:(id<CtFindAsyncProtocol>)aCallback param:(CtFindParam*)aFindParam override:(bool)aOverride;

-(NSMutableArray<CtMapObjectGroup*>*)findGroups:(CtFindParam*)aFindParam;

-(CtResult)findAsyncGroups:(id<CtFindAsyncGroupProtocol>)aCallback param:(CtFindParam*)aFindParam override:(bool)aOverride;

-(CtResult)findNearby:(NSMutableArray<CtMapObject*>*)aObjectArray featureType:(CtFeatureType)aFeatureType text:(NSString*)aText location:(CtGeometry*)aLocation;

-(CtResult)find:(NSMutableArray<CtMapObject*>*)aObjectArray maxItems:(int)aMaxItems address:(CtAddress*)aAddress fuzzy:(bool)aFuzzy;

-(CtResult)findAddressAsync:(id<CtFindAsyncProtocol>)aCallback maxItems:(int)aMaxItems address:(CtAddress*)aAddress fuzzy:(bool)aFuzzy override:(bool)aOverride;

-(CtResult)findInDisplay:(NSMutableArray<CtMapObject*>*)aObjectArray maxItems:(int)aMaxItems point:(CtPoint)aPoint radius:(double)aRadius;

-(CtResult)findInLayer:(NSMutableArray<CtMapObject*>*)aObjectArray maxItems:(int)aMaxItems layer:(NSString*)aLayer clip:(CtRect)aClip coordType:(CtCoordType)aCoordType;

-(CtResult)findPolygonsContainingPath:(NSMutableArray<CtMapObject*>*)aObjectArray path:(CtGeometry*)aPath findParam:(CtFindParam*)aFindParam;

-(CtResult)findPointsInPath:(NSMutableArray<CtMapObject*>*)aObjectArray path:(CtGeometry*)aPath findParam:(CtFindParam*)aFindParam;

-(NSString*)geoCodeSummary:(CtMapObject*)aMapObject;

-(NSString*)geoCodeSummary:(CtPoint)aPoint coordType:(CtCoordType)aCoordType;

-(CtResult)getAddress:(CtAddress*)aAddress mapObject:(CartoTypeMapObject*)aMapObject;

-(CtResult)getAddressFast:(CtAddress*)aAddress mapObject:(CtMapObject*)aMapObject;

-(CtResult)getAddress:(CtAddress*)aAddress point:(CtPoint)aPoint coordType:(CtCoordType)aCoordType;

-(double)height:(CtPoint)aPoint coordType:(CtCoordType)aCoordType;

-(NSMutableArray<NSNumber*>*)heights:(CtGeometry*)aGeometry;

-(void)setStyleSheetVariable:(NSString*)aName toString:(NSString*)aValue;

-(void)setStyleSheetVariable:(NSString*)aName toInt:(int)aValue;

@property (nonatomic) bool nightMode;

@property CtColor nightModeColor;

@property (nonatomic) NSMutableArray<CtBlendStyle*>* blendStyleSet;

@property (nonatomic) CtRouterType preferredRouterType;

@property (nonatomic) CtRouterType actualRouterType;

-(CtResult)startNavigationFrom:(CtPoint)aStart startCoordType:(CtCoordType)aStartCoordType to:(CtPoint)aEnd endCoordType:(CtCoordType)aEndCoordType;

-(CtResult)startNavigation:(CtRouteCoordSet*)aCoordSet;

-(CtResult)startNavigationDeferred:(CtRouteCoordSet*)aCoordSet;

-(void)endNavigation;

-(CtRoute*)createRouteWithProfile:(CtRouteProfile*)aProfile coordSet:(CtRouteCoordSet*)aCoordSet;

-(CtResult)createRouteAsync:(id<CtCreateRouteAsyncProtocol>)aCallback profile:(CtRouteProfile*)aProfile coordSet:(CtRouteCoordSet*)aCoordSet override:(bool)aOverride;

-(CtRoute*)createRouteFromXml:(NSString*)aFileNameOrData profile:(CtRouteProfile*)aProfile;

-(CtRoute*)createBestRouteWithProfile:(CtRouteProfile*)aProfile coordSet:(CtRouteCoordSet*)aCoordSet startfixed:(bool)aStartFixed endfixed:(bool)aEndFixed iterations:(int)aIterations;

-(CtResult)createBestRouteAsync:(id<CtCreateRouteAsyncProtocol>)aCallback profile:(CtRouteProfile*)aProfile coordSet:(CtRouteCoordSet*)aCoordSet startfixed:(bool)aStartFixed endfixed:(bool)aEndFixed iterations:(int)aIterations override:(bool)aOverride;

@property (nonatomic) bool navigationEnabled;

-(CtResult)loadNavigationData;    

-(CtResult)setRouteProfile:(CtRouteProfile*)aProfile;

-(CtResult)setRouteProfileType:(CtRouteProfileType)aProfileType;

-(CtRouteProfile*)routeProfile;

@property (nonatomic) int builtInRouteProfileCount;

-(CtRouteProfile*)builtInRouteProfile:(int)aIndex;

-(CtResult)setBuiltInRouteProfile:(int)aIndex;

+(void)createRouteProfile:(CtRouteProfile*)aProfile type:(CtRouteProfileType)aProfileType;

+(CtResult)readRouteProfileFromXmlFile:(CtRouteProfile*)aProfile filename:(NSString*)aFileName;

+(CtResult)readRouteProfileFromXmlString:(CtRouteProfile*)aProfile filename:(NSString*)aString;

+(CtResult)writeRouteProfileAsXmlFile:(CtRouteProfile*)aProfile filename:(NSString*)aFileName;

+(NSString*)writeRouteProfileAsXmlString:(CtRouteProfile*)aProfile;

@property (nonatomic) bool navigating;

@property (nonatomic) CtPoint routeStart;

@property (nonatomic) CtPoint routeEnd;

-(CtResult)displayRoute:(bool)aEnable;

@property (nonatomic) CtRoute* route;

@property (nonatomic) CtRouteSegment* currentRouteSegment;

-(CtResult)readRouteFromXml:(NSString*)aFileNameOrData;

-(NSString*)routeInstructions:(CtRoute*)aRoute;

-(CtResult)useRoute:(CtRoute*)aRoute;

-(CtResult)reverseRoute;

-(CtResult)deleteRoute;

-(CtResult)writeRouteAsXml:(CtRoute*)aRoute file:(NSString*)aFileName fileType:(CtFileType)aFileType;

-(NSString*)writeRouteAsXmlString:(CtRoute*)aRoute fileType:(CtFileType)aFileType;

-(CtResult)navigate:(CtNavigationData*)aNavData;

@property (nonatomic) CtTurn* firstTurn;

@property (nonatomic) CtTurn* secondTurn;

@property (nonatomic) CtTurn* continuationTurn;

@property (nonatomic) CtNavigationState navigationState;

@property (nonatomic) NSString* voiceInstruction;

@property (nonatomic) int navigationMinimumFixDistance;

@property (nonatomic) int navigationTimeOffRouteTolerance;

@property (nonatomic) int navigationDistanceOffRouteTolerance;

@property (nonatomic) CtNavigatorParam* navigatorParam;

@property (nonatomic) CtLocationMatchParam* locationMatchParam;

-(uint32_t)setNearbyObjectWarning:(uint32_t)aId layer:(NSString*)aLayer condition:(NSString*)aCondition maxDistance:(double)aMaxDistance maxObjectCount:(int)aMaxObjectCount;

-(uint32_t)setVehicleTypeWarning:(double)aMaxDistance maxObjectCount:(int)aMaxObjectCount;

-(bool)deleteNearbyObjectWarning:(uint32_t)aId;

-(bool)clearNearbyObjectWarnings;

-(NSMutableArray<CtMapObject*>*)copyNearbyObjects;

@property (nonatomic) double distanceToDestination;

@property (nonatomic) double estimatedTimeToDestination;

-(CtResult)findNearestRoad:(CtNearestRoadInfo*)aInfo point:(CtPoint)aPoint coordType:(CtCoordType)aCoordType headingInDegrees:(double)aHeadingInDegrees displayPosition:(bool)aDisplayPosition;

-(CtResult)displayPositionOnNearestRoad:(CtNavigationData*)aNavData nearestRoadInfo:(CtNearestRoadInfo*)aInfo;

-(void)setVehiclePosOffsetX:(double)aXOffset andY:(double)aYOffset;

@property (nonatomic) CtFollowMode followMode;

-(CtResult)setFollowScale:(double)aMinScale slowScale:(double)aSlowScale fastScale:(double)aFastScale maxScale:(double)aMaxScale;

-(CtResult)getNavigationPosition:(CtPoint*)aPoint coordType:(CtCoordType)aCoordType;

@property (nonatomic) NSString* locale;

@property (nonatomic) bool metricUnits;

-(NSString*)distanceToString:(double)aDistanceInMeters abbreviate:(bool)aAbbreviate;

-(NSString*)timeToString:(double)aTimeInSeconds;

-(NSString*)setCase:(NSString*)aString case:(CtLetterCase)aCase;

-(CtIdAndResult)addTrafficInfo:(uint64_t)aId trafficInfo:(CtTrafficInfo*)aTrafficInfo locationRef:(CtLocationRef*)aLocationRef;

-(CtIdAndResult)addPolygonSpeedLimit:(uint64_t)aId polygon:(CtGeometry*)aPolygon speed:(double)aSpeed vehicleTypes:(uint32_t)aVehicleTypes;

-(CtIdAndResult)addLineSpeedLimit:(uint64_t)aId line:(CtGeometry*)aLine speed:(double)aSpeed vehicleTypes:(uint32_t)aVehicleTypes;

-(CtIdAndResult)addClosedLineSpeedLimit:(uint64_t)aId line:(CtGeometry*)aLine speed:(double)aSpeed vehicleTypes:(uint32_t)aVehicleTypes;

-(CtIdAndResult)addForbiddenArea:(uint64_t)aId polygon:(CtGeometry*)aPolygon;

-(CtResult)deleteTrafficInfo:(uint64_t)aId;

-(void)clearTrafficInfo;

@property (nonatomic) bool trafficInfoEnabled;

-(void)startTracking;

-(void)endTracking;

-(void)deleteTrack;

-(bool)tracking;

@property (nonatomic) bool displayTrack;

@property (nonatomic) CtGeometry* track;

@property (nonatomic) double trackLengthInMeters;

-(CtResult)writeTrackAsXml:(NSString*)aFileName;

@property (nonatomic) NSString* trackAsXmlString;

-(CtAreaLengthAndResult)areaAndLength:(CtGeometry*)aGeometry;

-(CtAreaLengthAndResult)contourAreaAndLength:(CtGeometry*)aGeometry contourIndex:(int)aContourIndex;

+(double)azimuthInDegreesFrom:(CtPoint)aStart to:(CtPoint)aEnd;

+(CtPoint)pointAtAzimuthFrom:(CtPoint)aPoint dir:(double)aDir distance:(double)aDistanceInMeters;

+(double)greatCircleDistanceInMetersFrom:(CtPoint)aStart to:(CtPoint)aEnd;

+(NSData*)readUrl:(NSString*)aUrl;

+(NSString*)setAttributeInString:(NSString*)aString withKey:(NSString*)aKey andValue:(NSString*)aValue;

+(CtColor)makeColorR:(int)aR G:(int)aG B:(int)aB A:(int)aA;

+(CtColor)makeColor:(NSString*)aColor;

+(CtColor)setColor:(CtColor)aColor A:(int)aAlpha;

+(NSString*)errorString:(uint32_t)aCode;

+(NSString*)readFromUrl:(NSString*)aUrl postData:(NSString*)aPostData;

+(NSString*)UKGridReferenceFromDegrees:(CtPoint)aPointInDegrees digits:(int)aDigits;

+(CtPoint)PointInDegreesFromUKGridReference:(NSString*)aGridReference;
 
@end
@compatibility_alias CartoTypeFramework CtFramework;
 
#ifndef CARTOTYPE_WATCHOS

@interface CtMapRenderer: NSObject

-(id)init:(CtFramework*)aFramework;

-(void)draw;
 
@end
@compatibility_alias CartoTypeMapRenderer CtMapRenderer;
 
#endif