Inherits from NSObject
Conforms to PSKSensorDelegate
Declared in PARController.h

Overview

PARController

Tasks

Other Methods

Config Methods

Objects Methods

Properties

arObjects

NSArray containing all PARObjectDelegate-objects in the PARController

@property (nonatomic, readonly, strong) NSMutableArray *arObjects

Return Value

NSArray containing all PARObjectDelegate-objects in the PARController

Declared In

PARController.h

delegate

PARControllerDelegate delegate object receiving updates from the PARController

@property (nonatomic, assign) id<PARControllerDelegate> delegate

Discussion

PARControllerDelegate delegate object receiving updates from the PARController

Declared In

PARController.h

objectsNeedSorting

internal use only

@property (nonatomic, assign) BOOL objectsNeedSorting

Discussion

internal use only

Declared In

PARController.h

sensorDelegate

PSKSensorDelegate delegate object receiving updates from the PSKSensorManager

@property (nonatomic, assign) id<PSKSensorDelegate> sensorDelegate

Discussion

PSKSensorDelegate delegate object receiving updates from the PSKSensorManager

Declared In

PARController.h

started

YES if PARController is running updates

@property (nonatomic, readonly, assign, getter=isStarted) BOOL started

Return Value

YES if PARController is running updates

Declared In

PARController.h

Class Methods

deviceSupportsAR

checks if the device supports Augmented Reality functionality

+ (BOOL)deviceSupportsAR

Return Value

YES if AR functionality is supported by the device’s sensors @remarks Call this OR (BOOL)deviceSupportsAR:(BOOL)showErrors in applicationWillEnterForeground in the delegate to react to changes in the settings app

Discussion

checks if the device supports Augmented Reality functionality

Declared In

PARController.h

deviceSupportsAR:

checks if the device supports Augmented Reality functionality

+ (BOOL)deviceSupportsAR:(BOOL)showErrors

Parameters

showErrors

YES will rais UIAlertView’s with default messages defined in PanicARKit.strings @remarks Call this OR (BOOL)deviceSupportsAR in applicationWillEnterForeground in the delegate to react to changes in the settings app

Return Value

YES if AR functionality is supported by the device’s sensors

Discussion

checks if the device supports Augmented Reality functionality

Declared In

PARController.h

frameworkBundle

the NSBundle holding all framework resources

+ (NSBundle *)frameworkBundle

Declared In

PARController.h

localizedStringsBundle

the NSBundle holding all localized strings files

+ (NSBundle *)localizedStringsBundle

Declared In

PARController.h

sharedARController

shared PARController

+ (PARController *)sharedARController

Discussion

shared PARController

Declared In

PARController.h

showAlert:withMessage:andDismissButton:

shortcut method to show an UIAlertView with the passed parameters

+ (void)showAlert:(NSString *)title withMessage:(NSString *)message andDismissButton:(NSString *)dismissButtonTitle

Parameters

title

title of the alert

message

mesage of the alert

dismissButtonTitle

button title of the alert

Discussion

shortcut method to show an UIAlertView with the passed parameters

Declared In

PARController.h

Instance Methods

addMarker:

adds an PARPoiLabel to the controller Marker needs to have location!

- (PARPoiLabel *)addMarker:(PARPoiLabel *)marker

Parameters

marker

the marker to be added

Discussion

adds an PARPoiLabel to the controller Marker needs to have location!

Declared In

PARController+Objects.h

addMarkerAtLocation:atLocation:

adds the PARPoiLabel at the given location

- (PARPoiLabel *)addMarkerAtLocation:(PARPoiLabel *)marker atLocation:(CLLocation *)_location

Parameters

marker

the marker to be added

_location

the CLLocation @ref addObject

Discussion

adds the PARPoiLabel at the given location

Declared In

PARController+Objects.h

addMarkers:

adds an array of PARPoiLabel-type Objects to the controller Markers need to have locations assign, markers without will be omitted!

- (void)addMarkers:(NSArray *)array

Parameters

array

the array of markers to be added @ref addObjects

Discussion

adds an array of PARPoiLabel-type Objects to the controller Markers need to have locations assign, markers without will be omitted!

Declared In

PARController+Objects.h

addObject:

adds an object to the controller

- (void)addObject:(id<PARObjectDelegate>)anObject

Parameters

anObject

the object to add (implements @ref PARObjectDelegate)

Discussion

adds an object to the controller

Declared In

PARController+Objects.h

addObjects:

adds an array of PARObjectDelegate-type Objects to the controller Objects need to have locations assign, markers without will be omitted!

- (void)addObjects:(NSArray *)anArray

Parameters

anArray

the collection of objects to be added

Discussion

adds an array of PARObjectDelegate-type Objects to the controller Objects need to have locations assign, markers without will be omitted!

Declared In

PARController+Objects.h

availability

status of PARController functionality

- (PARAvailability)availability

Discussion

status of PARController functionality

Declared In

PARController.h

clearMarkers

remove all PARPoiLabels from the controller @ref clearObjects

- (void)clearMarkers

Discussion

remove all PARPoiLabels from the controller @ref clearObjects

Declared In

PARController+Objects.h

clearObjects

remove all objects from the controller

- (void)clearObjects

Discussion

remove all objects from the controller

Declared In

PARController+Objects.h

clipObjectsFarLimit

far clip limit @remarks objects farther away than this distance will not be rendered

- (float)clipObjectsFarLimit

Discussion

far clip limit @remarks objects farther away than this distance will not be rendered

Declared In

PARController+Config.h

clipObjectsNearLimit

near clip limit @remarks objects closer than this distance will not be rendered

- (float)clipObjectsNearLimit

Discussion

near clip limit @remarks objects closer than this distance will not be rendered

Declared In

PARController+Config.h

clipObjectsNearerThan:fartherThan:

objects closer than this distance will not be rendered

- (void)clipObjectsNearerThan:(float)theNearLimit fartherThan:(float)theFarLimit

Parameters

theNearLimit

objects closer than this distance will not be rendered

theFarLimit

objects farther away than this distance will not be rendered

Declared In

PARController+Config.h

frameworkBuild

build number

- (NSInteger)frameworkBuild

Discussion

build number

Declared In

PARController.h

frameworkConfiguration

configuration

- (NSString *)frameworkConfiguration

Discussion

configuration

Declared In

PARController.h

frameworkVersion

full version code

- (NSString *)frameworkVersion

Discussion

full version code

Declared In

PARController.h

freeMemory

free as much memory as possible (mainly by releasing OGL memory occupied by PARPoiLabel textures)

- (void)freeMemory

Discussion

free as much memory as possible (mainly by releasing OGL memory occupied by PARPoiLabel textures)

Declared In

PARController.h

hasValidApiKey

YES if valid API key is set

- (BOOL)hasValidApiKey

Return Value

YES if valid API key is set

Declared In

PARController.h

isFrozen

pause all updates in the PARViewController’s views @ref PARViewController:paused

- (BOOL)isFrozen

Discussion

pause all updates in the PARViewController’s views @ref PARViewController:paused

Declared In

PARController+Config.h

isReady

status of the PARController

- (BOOL)isReady

Return Value

YES if @ref availability is kPARStatusReady; @ref availability

Discussion

status of the PARController

Declared In

PARController+Config.h

isUpdatingObjects

YES if object update is running @remarks internal use only

- (BOOL)isUpdatingObjects

Return Value

YES if object update is running @remarks internal use only

Declared In

PARController.h

numberOfMarkers

the number of PARPoiLabels currently added to the Controller @ref numberOfObjects

- (int)numberOfMarkers

Return Value

the number of PARPoiLabels currently added to the Controller @ref numberOfObjects

Declared In

PARController+Objects.h

numberOfObjects

the number of objects currently added to the Controller

- (int)numberOfObjects

Return Value

the number of objects currently added to the Controller

Declared In

PARController+Objects.h

removeMarker:

remove a PARPoiLabel object

- (void)removeMarker:(PARPoiLabel *)object

Parameters

object

the marker to be added @ref removeObject

Discussion

remove a PARPoiLabel object

Declared In

PARController+Objects.h

removeObject:

remove an PARObjectDelegate object

- (void)removeObject:(id<PARObjectDelegate>)anObject

Parameters

anObject

the object to add (implements @ref PARObjectDelegate)

Discussion

remove an PARObjectDelegate object

Declared In

PARController+Objects.h

resumeFromBackground

resume PARController @remarks Call this from applicationWillEnterForeground in the delegate

- (void)resumeFromBackground

Discussion

resume PARController @remarks Call this from applicationWillEnterForeground in the delegate

Declared In

PARController.h

setApiKey:

the api key to disable the watermarks

- (void)setApiKey:(NSString *)theKey

Parameters

theKey

the api key to disable the watermarks

Declared In

PARController.h

setDefaultConfig

resets the default config @remarks: see individual settings for defaults

- (void)setDefaultConfig

Discussion

resets the default config @remarks: see individual settings for defaults

Declared In

PARController+Config.h

setFrozen:

pause all updates in the PARViewController’s views

- (void)setFrozen:(BOOL)frozen

Parameters

frozen

YES to pause, NO to unpause @ref PARViewController:setPaused

Discussion

pause all updates in the PARViewController’s views

Declared In

PARController+Config.h

start

will be called in PARViewController:viewDidAppear

- (void)start

Discussion

will be called in PARViewController:viewDidAppear

Declared In

PARController.h

stop

will be called in PARViewController:viewWillDisappear

- (void)stop

Discussion

will be called in PARViewController:viewWillDisappear

Declared In

PARController.h

suspendToBackground

suspend PARController @remarks Call this from applicationDidEnterBackground in the delegate

- (void)suspendToBackground

Discussion

suspend PARController @remarks Call this from applicationDidEnterBackground in the delegate

Declared In

PARController.h

willRenderObjectsForFirstTime

sort markers when distance changes @remarks internal use only

- (void)willRenderObjectsForFirstTime

Discussion

sort markers when distance changes @remarks internal use only

Declared In

PARController.h