ARKit教程

ARKit结构图

优秀博客代码：https://github.com/wangyansnow/ARKitDemo

https://www.jianshu.com/p/9d163675157e

ARKit框架简介：

ARkit负责捕捉画面，SceneKit负责渲染3D模型

ARKit并不是一个独立就能够运行的框架，而是必须要SceneKit一起用才可以，换一句话说，如果只有ARKit,而没有SceneKit，那么ARKit和一般的相机没有任何区别。

ARKit全框架API类图介绍：

ARAnchor

ARAnchor表示一个物体在3D空间的位置和方向（ARAnchor通常称为物体的3D锚点，有点像UIKit框架中CALayer的Anchor）, ARFrame表示的也是物体的位置和方向，但是ARFrame通常表示的是AR相机的位置和方向以及追踪相机的时间，还可以捕捉相机的帧图片。也就是说ARFrame用于捕捉相机的移动，其他虚拟物体用ARAnchor

//标识符@property(nonatomic, readonly) NSUUID*identifier;

//锚点的旋转变换矩阵，定义了锚点的旋转、位置、缩放。是一个4x4的矩阵（读者可以自行科普什么叫4x4矩阵）

@property(nonatomic, readonly) matrix_float4x4 transform;

//构造方法,一般我们无需构造。因为添加一个3D物体时ARKit会有代理告知我们物体的锚点

- (instancetype)initWithTransform:(matrix_float4x4)transform; 

ARCamera

ARCamera是一个相机，它是连接虚拟场景与现实场景之间的枢纽。在ARKit中，它是捕捉现实图像的相机，在SceneKit中它又是3D虚拟世界中的相机。

一般我们无需去创建一个相机，因为当我们初始化一个AR试图时，他会为我们默认创建一个相机，而且这个相机就是摄像头的位置，同时也是3D世界中的原点所在（x=0,y=0,z=0）

@interfaceARCamera: NSObject

/** 4x4矩阵表示相机位置，同ARAnchor */

@property(nonatomic, readonly) matrix_float4x4 transform;

/** 相机方向（旋转）的矢量欧拉角 分别是x/y/z */

@property(nonatomic, readonly) vector_float3 eulerAngles;

/** 相机追踪状态（在下方会有枚举值介绍） */

@property(nonatomic, readonly) ARTrackingState trackingState NS_REFINED_FOR_SWIFT;

/** 追踪运动类型 */

@property(nonatomic, readonly) ARTrackingStateReason trackingStateReason NS_REFINED_FOR_SWIFT;

/** 相机曲率（笔者有点费解，反复揣摩应该是与焦距相关参数） 3x3矩阵 fx 0 px 0 fy py 0 0 1 */

@property(nonatomic, readonly) matrix_float3x3 intrinsics;

/** 摄像头分辨率 */

@property(nonatomic, readonly) CGSizeimageResolution;

/** 投影矩阵 */

@property(nonatomic, readonly) matrix_float4x4 projectionMatrix;

/** 创建相机投影矩阵 */

- (matrix_float4x4)projectionMatrixWithViewportSize:(CGSize)viewportSize orientation:(UIInterfaceOrientation)orientation zNear:(CGFloat)zNear zFar:(CGFloat)zFar;

@end

//相机追踪状态枚举

typedef NS_ENUM(NSInteger, ARTrackingState) {

/** 不被允许 */

ARTrackingStateNotAvailable,

/** 最小 */

ARTrackingStateLimited,

/** 正常. */

ARTrackingStateNormal, } NS_REFINED_FOR_SWIFT;

/** 追踪运动类型 */

typedef NS_ENUM(NSInteger, ARTrackingStateReason) {

/** 无. */ARTrackingStateReasonNone,

/** 运动. */ARTrackingStateReasonExcessiveMotion,

/** 脸部捕捉. */ARTrackingStateReasonInsufficientFeatures, }NS_REFINED_FOR_SWIFT

ARFrame

ARFrame主要是追踪相机当前的状态，这个状态不仅仅只是位置，还有图像帧及时间等参数

@interface ARFrame: NSObject

/** 时间戳. */

@property(nonatomic, readonly) NSTimeIntervaltimestamp;

/** 缓冲区图像帧 */

@property(nonatomic, readonly) CVPixelBufferRef capturedImage;

/** 相机（表示这个ARFrame是哪一个相机的，iPhone7plus有两个摄像机）*/

@property(nonatomic, copy, readonly) ARCamera *camera;

/** 返回当前相机捕捉到的锚点数据（当一个3D虚拟模型加入到ARKit中时，锚点值得就是这个模型在AR中的位置） */

@property(nonatomic, copy, readonly) NSArray *anchors;

/** 灯光，详情可见本章节ARLightEstimate类介绍（指的是灯光强度 一般是0-2000，系统默认1000） */

@property(nonatomic, copy, nullable, readonly) ARLightEstimate *lightEstimate;

/** 特征点（应该是捕捉平地或者人脸的，比较苹果有自带的人脸识别功能） */

@property(nonatomic, nullable, readonly) ARPointCloud *rawFeaturePoints;

/** 根据2D坐标点搜索3D模型，这个方法通常用于，当我们在手机屏幕点击某一个点的时候，可以捕捉到这一个点所在的3D模型的位置，至于为什么是一个数组非常好理解。手机屏幕一个是长方形，这是一个二维空间。而相机捕捉到的是一个由这个二维空间射出去的长方体，我们点击屏幕一个点可以理解为在这个长方体的边缘射出一条线，这一条线上可能会有多个3D物体模型 

point：2D坐标点（手机屏幕某一点） 

ARHitTestResultType：捕捉类型 点还是面 (NSArray *)：追踪结果数组 详情见本章节ARHitTestResult类介绍 */

- (NSArray *)hitTest:(CGPoint)point types:(ARHitTestResultType)types;

/** 相机窗口的的坐标变换（可用于相机横竖屏的旋转适配） */

- (CGAffineTransform)displayTransformWithViewportSize:(CGSize)viewportSize orientation:(UIInterfaceOrientation)orientation;@end

ARHitTestResult

ARHitTestResult：点击回调结果，这个类主要用于虚拟增强现实技术（AR技术）中现实世界与3D场景中虚拟物体的交互。 比如我们在相机中移动。拖拽3D虚拟物体，都可以通过这个类来获取ARKit所捕捉的结果。

//捕捉类型枚举

typedefNS_OPTIONS(NSUInteger, ARHitTestResultType) {

/** 点. */ ARHitTestResultTypeFeaturePoint = (1<< 0),

/** 水平面 y为0. */ ARHitTestResultTypeEstimatedHorizontalPlane = (1<< 1),

/** 已结存在的平面. */ ARHitTestResultTypeExistingPlane = (1<< 3),

/** 已结存在的锚点和平面. */ ARHitTestResultTypeExistingPlaneUsingExtent = (1<< 4),

 } NS_SWIFT_NAME(ARHitTestResult.ResultType);

/** 捕捉类型 */

@property(nonatomic, readonly) ARHitTestResultType type;

/** 3D虚拟物体与相机的距离（单位：米） */

@property(nonatomic, readonly) CGFloatdistance;

/** 本地坐标矩阵（世界坐标指的是相机为场景原点的坐标，而每一个3D物体自身有一个场景，本地坐标就是相对于这个场景的坐标）类似于frame和bounds的区别 */

@property(nonatomic, readonly) matrix_float4x4 localTransform;

/** 世界坐标矩阵 */

@property(nonatomic, readonly) matrix_float4x4 worldTransform;

/** 锚点（3D虚拟物体，在虚拟世界有一个位置，这个位置参数是SceneKit中的SCNVector3：三维矢量），而锚点anchor是这个物体在AR现实场景中的位置，是一个4x4的矩阵 */

@property(nonatomic, strong, nullable, readonly) ARAnchor *anchor;

@end

ARLightEstimate

ARLightEstimate是一个灯光效果，它可以让你的AR场景看起来更加的好

@interface ARLightEstimate: NSObject

/** 灯光强度 范围0-2000 默认1000 */

@property(nonatomic, readonly) CGFloatambientIntensity;

@end

ARPlaneAnchor

ARPlaneAnchor是ARAnchor的子类，笔者称之为平地锚点。ARKit能够自动识别平地，并且会默认添加一个锚点到场景中，当然要想看到真实世界中的平地效果，需要我们自己使用SCNNode来渲染这个锚点，锚点只是一个位置。

/** 平地类型，目前只有一个，就是水平面 */

@property(nonatomic, readonly) ARPlaneAnchorAlignment alignment;

/** 3轴矢量结构体，表示平地的中心点 x/y/z */

@property(nonatomic, readonly) vector_float3 center;

/** 3轴矢量结构体，表示平地的大小（宽度和高度） x/y/z */

@property(nonatomic, readonly) vector_float3 extent;

@end

ARPointCloud

ARPointCloud：点状渲染云，主要用于渲染场景

interface ARPointCloud: NSObject

/** 点的数量 */

@property(nonatomic, readonly) NSUIntegercount;

/** 每一个点的位置的集合（结构体带*表示的是结构体数组） */

@property(nonatomic, readonly) constvector_float3 *points;

@end

ARSCNView

AR视图， ARKit支持3D的AR场景和2D的AR场景，ARSCNView是3D的AR场景视图，该类是整个ARKit框架中唯一两个有代理的类其中之一。该类非常重要，且API较多.

@interface ARSCNView: SCNView

/** 代理 */

@property(nonatomic, weak, nullable) id delegate;

/** AR会话 */

@property(nonatomic, strong) ARSession *session;

/** 场景 */

@property(nonatomic, strong) SCNScene*scene;

/** 是否自动适应灯光 */

@property(nonatomic) BOO LautomaticallyUpdatesLighting;

/** 返回对应节点的锚点，节点是一个3D虚拟物体，它的坐标是虚拟场景中的坐标，而锚点ARAnchor是ARKit中现实世界的坐标。 */

- (nullableARAnchor *)anchorForNode:(SCNNode*)node;

/** 返回对应锚点的物体 */

- (nullableSCNNode*)nodeForAnchor:(ARAnchor *)anchor;

/** 根据2D坐标点搜索3D模型，这个方法通常用于，当我们在手机屏幕点击某一个点的时候，可以捕捉到这一个点所在的3D模型的位置，至于为什么是一个数组非常好理解。手机屏幕一个是长方形，这是一个二维空间。而相机捕捉到的是一个由这个二维空间射出去的长方体，我们点击屏幕一个点可以理解为在这个长方体的边缘射出一条线，这一条线上可能会有多个3D物体模型 

point：2D坐标点（手机屏幕某一点） 

ARHitTestResultType：捕捉类型 点还是面 (NSArray *)：追踪结果数组 详情见本章节ARHitTestResult类介绍 数组的结果排序是由近到远 */

- (NSArray *)hitTest:(CGPoint)point types:(ARHitTestResultType)types;

@end

//代理

#pragma mark - ARSCNViewDelegate

//代理的内部实现了SCNSceneRendererDelegate：scenekit代理 和ARSessionObserver：ARSession监听（KVO机制）@protocolARSCNViewDelegate@optional

/** 自定义节点的锚点 */

- (nullableSCNNode*)renderer:(id)renderer nodeForAnchor:(ARAnchor *)anchor;

/** 当添加节点是会调用，我们可以通过这个代理方法得知我们添加一个虚拟物体到AR场景下的锚点（AR现实世界中的坐标） */

- (void)renderer:(id)renderer didAddNode:(SCNNode*)node forAnchor:(ARAnchor *)anchor;

/** 将要刷新节点 */

- (void)renderer:(id)renderer willUpdateNode:(SCNNode*)node forAnchor:(ARAnchor *)anchor;

/** 已经刷新节点 */

- (void)renderer:(id)renderer didUpdateNode:(SCNNode*)node forAnchor:(ARAnchor *)anchor;

/** 移除节点 */

- (void)renderer:(id)renderer didRemoveNode:(SCNNode*)node forAnchor:(ARAnchor *)anchor;

@end

ARSession

ARSession是一个连接底层与AR视图之间的桥梁，其实ARSCNView内部所有的代理方法都是由ARSession来提供的。

ARSession获取相机位置数据主要有两种方式

push。 实时不断的获取相机位置，由ARSession主动告知用户。通过实现ARSession的代理- (void)session:(ARSession *)session didUpdateFrame:(ARFrame *)frame来获取

pull。 用户想要时，主动去获取。ARSession的属性currentFrame来获取

@interface ARSession: NSObject

/** 代理 */

@property(nonatomic, weak) id delegate;

/** 指定代理执行的线程（主线程不会有延迟，子线程会有延迟），不指定的话默认主线程 */

@property(nonatomic, strong, nullable) dispatch_queue_t delegateQueue;

/** 相机当前的位置（是由会话追踪配置计算出来的） */

@property(nonatomic, copy, nullable, readonly) ARFrame *currentFrame;

/** 会话追踪配置 */

@property(nonatomic, copy, nullable, readonly) ARSessionConfiguration *configuration;

/** 运行会话（这行代码就是开启AR的关键所在） */

- (void)runWithConfiguration:(ARSessionConfiguration *)configuration NS_SWIFT_UNAVAILABLE("Use run(_:options:)");

/** 运行会话，只是多了一个参数ARSessionRunOptions：作用就是会话断开重连时的行为。ARSessionRunOptionResetTracking：表示充值追踪 ARSessionRunOptionRemoveExistingAnchors：移除现有锚点 */

- (void)runWithConfiguration:(ARSessionConfiguration *)configuration options:(ARSessionRunOptions)options NS_SWIFT_NAME(run(_:options:));

/** 暂停会话 */

- (void)pause;

/** 添加锚点 */

- (void)addAnchor:(ARAnchor *)anchor NS_SWIFT_NAME(add(anchor:));

/** 移除锚点 */

- (void)removeAnchor:(ARAnchor *)anchor NS_SWIFT_NAME(remove(anchor:));

@end

//session代理分类两部分，一个是观察者（KVO） 一个是委托者（代理）#pragma mark - ARSessionObserver //session KVO观察者

@protocol ARSessionObserver

@optional

/** session失败 */

- (void)session:(ARSession *)session didFailWithError:(NSError*)error;

/** 相机改变追踪状态 */

- (void)session:(ARSession *)session cameraDidChangeTrackingState:(ARCamera *)camera;

/** session意外断开（如果开启ARSession之后，APP退到后台就有可能导致会话断开） */

- (void)sessionWasInterrupted:(ARSession *)session;

/** session会话断开恢复（短时间退到后台再进入APP会自动恢复） */

- (void)sessionInterruptionEnded:(ARSession *)session;

@end

#pragma mark - ARSessionDelegate

@protocol ARSessionDelegate

@optional

/** 更新相机位置 */

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

/** 添加锚点 */

- (void)session:(ARSession *)session didAddAnchors:(NSArray*)anchors;

/** 刷新锚点 */

- (void)session:(ARSession *)session didUpdateAnchors:(NSArray*)anchors;

/** 移除锚点 */

- (void)session:(ARSession *)session didRemoveAnchors:(NSArray*)anchors;

@end

ARSessionConfiguration

ARSessionConfiguration会话追踪配置，主要就是追踪相机的配置。注意：该类还有一个子类：ARWorldTrackingSessionConfiguration，它们在同一个API文件中

//会话追踪配置类

@interface ARSessionConfiguration: NSObject

/** 当前设备是否支持，一般A9芯片以下设备不支持 */

@property(class, nonatomic, readonly) BOO LisSupported;

/** 会话的对其方式，这里的对其指的是3D世界的坐标。枚举值见下方*/

@property(nonatomic, readwrite) ARWorldAlignment worldAlignment;

/** 是否需要自适应灯光效果，默认是YES */

@property(nonatomic, readwrite, getter=isLightEstimationEnabled) BOOL lightEstimationEnabled;

@end

//世界会话追踪配置，苹果建议我们使用这个类，这个子类只有一个属性，也就是可以帮助我们追踪相机捕捉到的平地

@interface ARWorldTrackingSessionConfiguration: ARSessionConfiguration

/** 侦查类型。枚举值见下方（默认侦查平地） */

@property(nonatomic, readwrite) ARPlaneDetection planeDetection;

@end

追踪对其方式，这个决定了参考坐标系（参照物）

typedef NS_ENUM(NSInteger, ARWorldAlignment) {

/* 相机位置 vector (0, -1, 0) */ 

ARWorldAlignmentGravity,

 /** 相机位置及方向. vector (0, -1, 0) heading ：(0, 0, -1) */

ARWorldAlignmentGravityAndHeading,

/** 相机方向. */

ARWorldAlignmentCamera

 } 

/平面检测类型*/

typedef NS_OPTIONS(NSUInteger, ARPlaneDetection) { 

/ 不检测. */ 

ARPlaneDetectionNone = 0,

/** 平地检测 */

ARPlaneDetectionHorizontal = (1<< 0),

 }