ARGyroManager Class Reference

#import <ARGyroManager.h>

Inheritance diagram for ARGyroManager:

Collaboration diagram for ARGyroManager:

Public Types
enum	ARGyroManagerState { ARGyroManagerStateInitialised, ARGyroManagerStateStopped, ARGyroManagerStateStarted }
enum	ARGyroManagerStateInternal { ARGyroManagerStateInternalInitialised, ARGyroManagerStateInternalStopped, ARGyroManagerStateInternalStarted }

Instance Methods
(void)	- initialise
(void)	- deinitialise
(void)	- start
(void)	- stop
(void)	- actualStart
(void)	- actualStop
(void)	- updateNode
(void)	- addDelegate:
(void)	- removeDelegate:
Instance Methods inherited from <ARRendererDelegate>
(void)	- rendererPreRender
(void)	- rendererPostRender
(void)	- rendererDidPause
(void)	- rendererDidResume

Class Methods
(ARGyroManager *)	+ getInstance

Properties
ARGyroManagerState	gyroState
ARGyroManagerStateInternal	internalGyroState
CMMotionManager *	motionManager
CMAttitudeReferenceFrame	gyroReferenceFrame
ARWorld *	world

Detailed Description

A manager class representing the device's gyro. This class is resposible for using IMU data to transform AR content with device rotations.

Member Enumeration Documentation

- (enum) ARGyroManagerState

Enum representing the gyro's state.

Enumerator
ARGyroManagerStateInitialised	ARGyroManagerStateInitialised Gyro is initialised.
ARGyroManagerStateStopped	ARGyroManagerStateStopped Gyro is not running.
ARGyroManagerStateStarted	ARGyroManagerStateStarted Gyro is running.

- (enum) ARGyroManagerStateInternal

Enum representing the gyro managers internal state.

Enumerator
ARGyroManagerStateInternalInitialised	ARGyroManagerStateInitialised Gyro is initialised.
ARGyroManagerStateInternalStopped	ARGyroManagerStateStopped Gyro is not running.
ARGyroManagerStateInternalStarted	ARGyroManagerStateStarted Gyro is running.

Method Documentation

- (void) addDelegate:

(id< ARGyroManagerDelegate >)

delegate

Add a delegate for gyro event notifications.

Parameters

delegate

The delegate to add to the Gyro Manager.

- (void) deinitialise

Deinitialises the ARGyroManager singleton and dereferences CMMotiionManger.

+ (ARGyroManager *) getInstance

Returns

ARGyroManager singleton Returns the ARGyroManager singleton. Initialises if it hasn't been allready.

- (void) initialise

Initialises the ARGyroManager singleton and the CMMotionManger with a default gyro update interval of 0.05 seconds.

- (void) removeDelegate:

(id< ARGyroManagerDelegate >)

delegate

Remove a delegate for gyro event notifications.

Parameters

delegate

The delegate to remove from the Gyro Manager.

- (void) start

Starts device motion updates and adds ARGyroManager to the list of ARRenderDelegates.

- (void) stop

Stops device motion updates and removes ARGyroManager from the list of ARRenderDelegates.

- (void) updateNode

Updates the world orientation.

Property Documentation

- (CMAttitudeReferenceFrame) gyroReferenceFrame

readwritenonatomicassign

The reference frame used to start the motion manager. Default is CMAttitudeReferenceFrameXTrueNorthZVertical.

- (ARGyroManagerState) gyroState

readwritenonatomicassign

The gyro manager's current state.

- (ARGyroManagerStateInternal) internalGyroState

readwritenonatomicassign

The gyro managers current internal state

- (CMMotionManager*) motionManager

readnonatomicassign

The motion manager used to update the ARGyroManager's orientation.

- (ARWorld*) world

readwritenonatomicassign

A node representing the ARGyroManager's world.

---

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

• ARGyroManager.h