Skip to content
azeitler edited this page Sep 24, 2012 · 99 revisions

PanicAR Framework

News

September 24th, 2012 v2.00 released:

  • Framework is now called PanicARKit
  • iOS 6 support and pre-iOS 5 deprecation
  • armv7s compatible
  • supported devices now are: iPhone 4, iPhone 4s, iPhone 5, iPad 2, iPad 3 (new iPad)
  • supported iOS versions now are: 5.0 and later
  • supports all orientations and dynamic changes with and without orientation lock
  • accuracy and stability fixes
  • UI improvements: radar view improvements, new notificationView (e.g. "Location Services Denied")
  • handling for changes in authorization status for location services
  • Important see 1.2x and 2.x Upgrade Guide to migrate projects using older versions of PanicAR

April 4th, 2012 v1.5.1 released: Minor bug-fix update for v1.0x fork of PanicAR.

  • fix: status bar disappears
  • fix: loading view does not disappear on iOS 5.x

January 20th, 2012 v1.20 beta-access: Major update including iPad support, tracking improvements and shift from OpenGL to UIKit. Check the Migration Guide to learn how to upgrade an App which previously used an older revision of PanicAR.

December 11th, 2011 early-adopter access to v1.20

November 21st, 2011 early-adopter access to v1.10

August 4th, 2011 v1.05 final and stable on master branch (iOS 5 compatible): Includes hot-fix for iOS 5 (see issues). Updated documentation online.

July 26th, 2011 new ARNotes version available on the App Store (no iOS 5 compatible)

July 19th, 2011 public access to v1.05 (development branch): Adds access to the highly optimized release build of the framework for licensees.

July 18th, 2011 release of v1.04: Includes hot-fix for iOS 5 (see issues). Updated documentation online.


What's PanicAR

Visit our Product Page to get more Information: www.dopanic.com/ar


Requirements

  • Minimum: iOS 4.0, Recommended: iOS 5.0
  • Devices: iPhone 3Gs, iPhone 4, iPhone 4Gs, iPad (no camera feed), iPad 2
  • Software: Xcode 4.2 (recommended)

Getting Started

  1. Download or checkout the lastest revision of the Framework and Demo Project (i.e. this repository)
  2. Open the Demo Project in XCode and build the Demo directly to your Device
  3. Should you have any trouble with 2., then checkout the Requirements and the Manual
  4. Read about the Limitations of the Demo Framework in Framework Versions & Demo Limitations (below)
  5. Check in with the Best Practices (below) section and the Issue Tracker
  6. Purchase a License

Changelog

Check the Changelog file in the repository.

Legacy Document: Migration Guide


Manual

Integrate in any App: step-by-step guide for new users

Demo Project: short overview on how the demo project is setup


Framework Versions and Demo Limitations

Demo Limitations & API Key

The PanicAR Framework requires an API-key to unlock all functionality. As long as no valid API key is provided during initialization, the demo version will display watermarks in the AR view and on POI Labels. You are not allowed to submit any Apps to the App Store without obtaining an valid API key before hand.

Limitations:

  • displays a watermark in the AR View
  • adds watermarks to all objects loaded from PARPoiLabelTemplate

API KEY

A API Key is tied to one specific BundleID (e.g. com.company.myapp) and will only work with apps that use exactly that BundleID. We happily provide you with different API Keys for testing purposes once you purchased your first license.


Framework Versions

Debug Version

This public repository contains a fully-functional copy of the Debug Version of the PanicAR Framework. The development build includes debug functionality and is not for use in production apps and for release on the App Store (see below).

  • has extensive debug output
  • has a console view which can be displayed in your app
  • supports modification of PARController.capabilities to simulate older hardware and iOS
  • for development purposes ONLY! (do not release an App using the Debug Version)

Release Version

The Release Version of the framework is also included in the repository. The release build is highly optimized for production use and does not contain any debug functionality (whereas the development build does).

  • highly optimized
  • no debug output – only essential logging
  • for production purposes

Using the Release Version

The Release Version is included in the Demo Project in a secondary build target, which points to the Release-Framework folder rather than the Debug-Framework folder.


Best Practices

get tips on how to tackle common yet tricky coding situations: Best Practices

Old Revision


API Reference

Available at: http://docs.dopanic.com/panicar-120/

Legacy Documentation (v1.0x): http://docs.dopanic.com/panicar-105/


Licensing

Visit our Product Page to purchase a commercial license: www.dopanic.com/ar

Contact Us if you want to receive a non-commercial license for use in non-profit or academic use.


Troubleshooting

Help with day-to-day questions or problems; workarounds, bug-fixes and FYIs: Current Revision

Old Revision


Clone this wiki locally