Ocean
AKRoomPlanTracker6DOF_Objc Class Reference

This class implements the Objc wrapper for the room plan tracker. More...

Inheritance diagram for AKRoomPlanTracker6DOF_Objc:

Instance Methods

(bool) - start:
 Starts the tracker. More...
 
(bool) - stop
 Stopps the tracker. More...
 
(void) - onSessionTest:didUpdateFrame:
 Event function for frame update events. More...
 
(void) - onCaptureSessionStarted
 Event function when the capture session has started. More...
 
(void) - onCaptureSessionAdded:andVolumetric:
 Event function for added room objects. More...
 
(void) - onCaptureSessionRemoved:andVolumetric:
 Event function for removed room objects. More...
 
(void) - onCaptureSessionChanged:andVolumetric:
 Event function for changed room objects. More...
 
(void) - onCaptureSessionUpdated:andVolumetric:
 Event function for updated room objects. More...
 
(void) - onCaptureSessionInstruction:
 Event function for instructions. More...
 
(void) - onCaptureSessionStopped
 Event function when the capture session has stopped. More...
 

Class Methods

(bool) + isSupported
 Returns whether the tracker is supported on this platform. More...
 

Detailed Description

This class implements the Objc wrapper for the room plan tracker.

Method Documentation

◆ isSupported

+ (bool) isSupported

Returns whether the tracker is supported on this platform.

Returns
True, if so

◆ onCaptureSessionAdded:andVolumetric:

- (void) onCaptureSessionAdded: (NSArray< PlanarRoomObject * > *)  planarRoomObjects
andVolumetric: (NSArray< VolumetricRoomObject * > *)  volumetricRoomObjects 

Event function for added room objects.

Parameters
planarRoomObjectsThe new planar objects
volumetricRoomObjectsThe new volumetric objects

◆ onCaptureSessionChanged:andVolumetric:

- (void) onCaptureSessionChanged: (NSArray< PlanarRoomObject * > *)  planarRoomObjects
andVolumetric: (NSArray< VolumetricRoomObject * > *)  volumetricRoomObjects 

Event function for changed room objects.

Parameters
planarRoomObjectsThe changed planar objects
volumetricRoomObjectsThe changed volumetric objects

◆ onCaptureSessionInstruction:

- (void) onCaptureSessionInstruction: (NSString *)  instruction

Event function for instructions.

Parameters
instructionThe instruction which can be used to improve the capture result

◆ onCaptureSessionRemoved:andVolumetric:

- (void) onCaptureSessionRemoved: (NSArray< PlanarRoomObject * > *)  planarRoomObjects
andVolumetric: (NSArray< VolumetricRoomObject * > *)  volumetricRoomObjects 

Event function for removed room objects.

Parameters
planarRoomObjectsThe removed planar objects
volumetricRoomObjectsThe removed volumetric objects

◆ onCaptureSessionStarted

- (void) onCaptureSessionStarted

Event function when the capture session has started.

◆ onCaptureSessionStopped

- (void) onCaptureSessionStopped

Event function when the capture session has stopped.

◆ onCaptureSessionUpdated:andVolumetric:

- (void) onCaptureSessionUpdated: (NSArray< PlanarRoomObject * > *)  planarRoomObjects
andVolumetric: (NSArray< VolumetricRoomObject * > *)  volumetricRoomObjects 

Event function for updated room objects.

Parameters
planarRoomObjectsThe updated planar objects
volumetricRoomObjectsThe updated volumetric objects

◆ onSessionTest:didUpdateFrame:

- (void) onSessionTest: (ARSession *)  session
didUpdateFrame: (ARFrame *)  frame 

Event function for frame update events.

Parameters
sessionThe sending session
frameThe updated frame

◆ start:

- (bool) start: (AKRoomPlanTracker6DOFOwnerContainer *)  ownerContainer

Starts the tracker.

Parameters
ownerContainerThe owner's delegate of this tracker
Returns
True, if succeeded

◆ stop

- (bool) stop

Stopps the tracker.

Returns
True, if succeeded

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