ARKit從入門到精通(4)-ARKit全框架API大全

<h2 id="1.1">1.1-ARKit框架簡介

  • 再上一小節(jié)中悠菜,相信大家已經(jīng)對<ARKit>框架的使用及原理有了一個全局的認識,為了能夠更加深入的研究學(xué)習(xí)ARKit技術(shù)辉懒,所以筆者本小節(jié)主要介紹<ARKit>框架中所有的API

    • 本篇主要翻譯自蘋果官方文檔彻亲,適當(dāng)加上一些筆者的見解
  • ARKit框架類圖

0501.png

<h2 id="1.2">1.2-ARAnchor</h2>

  • ARAnchor表示一個物體在3D空間的位置和方向(ARAnchor通常稱為物體的3D錨點送滞,有點像UIKit框架中CALayer的Anchor)
    • ARFrame表示的也是物體的位置和方向剖张,但是ARFrame通常表示的是AR相機的位置和方向以及追蹤相機的時間,還可以捕捉相機的幀圖片
      • 也就是說ARFrame用于捕捉相機的移動养距,其他虛擬物體用ARAnchor

@interface ARAnchor : NSObject <NSCopying>

/**
 標識符
 */
@property (nonatomic, readonly) NSUUID *identifier;

/**
 錨點的旋轉(zhuǎn)變換矩陣尤筐,定義了錨點的旋轉(zhuǎn)汇荐、位置、縮放盆繁。是一個4x4的矩陣(讀者可以自行科普什么叫4x4矩陣)
 */
@property (nonatomic, readonly) matrix_float4x4 transform;

/**
 構(gòu)造方法,一般我們無需構(gòu)造掀淘。因為添加一個3D物體時ARKit會有代理告知我們物體的錨點
 */
- (instancetype)initWithTransform:(matrix_float4x4)transform;

@end


<h2 id="1.3">1.3-ARCamera</h2>

  • *AR相機,該類API較多改基,并且理解比較困難繁疤,將會在后續(xù)小節(jié)單獨介紹
    • 該類非常重要,且API較多秕狰,將在后續(xù)小節(jié)介紹

<h2 id="1.4">1.4-ARError</h2>

  • ARError是一個描述ARKit錯誤的類稠腊,這個錯誤來源于幾個方面,例如設(shè)備不支持鸣哀,或者當(dāng)相機常駐后臺時ARSession會斷開等問題

//作用域架忌,一般會表示是哪一個類出現(xiàn)問題
NSString *const ARErrorDomain;

//錯誤碼描述  100:不支持會話追蹤配置,主線由于A9芯片以下的機型會報錯   101:失活狀態(tài) 102:傳感器故障  200:追蹤失敗
typedef NS_ERROR_ENUM(ARErrorDomain, ARErrorCode) {
    /** Unsupported session configuration. */
    ARErrorCodeUnsupportedConfiguration   = 100,
    
    /** A sensor required to run the session is not available. */
    ARErrorCodeSensorUnavailable          = 101,
    
    /** A sensor failed to provide the required input. */
    ARErrorCodeSensorFailed               = 102,
    
    /** World tracking has encountered a fatal error. */
    ARErrorCodeWorldTrackingFailed        = 200,
};

<h2 id="1.5">1.5-ARFrame</h2>

  • ARFrame主要是追蹤相機當(dāng)前的狀態(tài)我衬,這個狀態(tài)不僅僅只是位置叹放,還有圖像幀及時間等參數(shù)

@interface ARFrame : NSObject <NSCopying>

/**
時間戳.
 */
@property (nonatomic, readonly) NSTimeInterval timestamp;

/**
 緩沖區(qū)圖像幀
 */
@property (nonatomic, readonly) CVPixelBufferRef capturedImage;

/**
相機(表示這個ARFrame是哪一個相機的饰恕,iPhone7plus有兩個攝像機)
 */
@property (nonatomic, copy, readonly) ARCamera *camera;

/**
 返回當(dāng)前相機捕捉到的錨點數(shù)據(jù)(當(dāng)一個3D虛擬模型加入到ARKit中時,錨點值得就是這個模型在AR中的位置)
 */
@property (nonatomic, copy, readonly) NSArray<ARAnchor *> *anchors;

/**
燈光井仰,詳情可見本章節(jié)ARLightEstimate類介紹(指的是燈光強度 一般是0-2000埋嵌,系統(tǒng)默認1000)
 */
@property (nonatomic, copy, nullable, readonly) ARLightEstimate *lightEstimate;

/**
特征點(應(yīng)該是捕捉平地或者人臉的,比較蘋果有自帶的人臉識別功能)
 */
@property (nonatomic, nullable, readonly) ARPointCloud *rawFeaturePoints;

/**
根據(jù)2D坐標點搜索3D模型俱恶,這個方法通常用于雹嗦,當(dāng)我們在手機屏幕點擊某一個點的時候,可以捕捉到這一個點所在的3D模型的位置合是,至于為什么是一個數(shù)組非常好理解了罪。手機屏幕一個是長方形,這是一個二維空間聪全。而相機捕捉到的是一個由這個二維空間射出去的長方體泊藕,我們點擊屏幕一個點可以理解為在這個長方體的邊緣射出一條線,這一條線上可能會有多個3D物體模型
point:2D坐標點(手機屏幕某一點)
ARHitTestResultType:捕捉類型  點還是面
(NSArray<ARHitTestResult *> *):追蹤結(jié)果數(shù)組  詳情見本章節(jié)ARHitTestResult類介紹

 */
- (NSArray<ARHitTestResult *> *)hitTest:(CGPoint)point types:(ARHitTestResultType)types;

/**
相機窗口的的坐標變換(可用于相機橫豎屏的旋轉(zhuǎn)適配)
 */
- (CGAffineTransform)displayTransformWithViewportSize:(CGSize)viewportSize orientation:(UIInterfaceOrientation)orientation;

@end

<h2 id="1.6">1.6-ARHitTestResult</h2>

  • ARHitTestResult:點擊回調(diào)結(jié)果难礼,這個類主要用于虛擬增強現(xiàn)實技術(shù)(AR技術(shù))中現(xiàn)實世界與3D場景中虛擬物體的交互娃圆。 比如我們在相機中移動。拖拽3D虛擬物體鹤竭,都可以通過這個類來獲取ARKit所捕捉的結(jié)果

//捕捉類型枚舉
typedef NS_OPTIONS(NSUInteger, ARHitTestResultType) {
    /** 點. */
    ARHitTestResultTypeFeaturePoint              = (1 << 0),
    
    /** 水平面 y為0. */
    ARHitTestResultTypeEstimatedHorizontalPlane  = (1 << 1),
    
    /** 已結(jié)存在的平面. */
    ARHitTestResultTypeExistingPlane             = (1 << 3),
    
    /** 已結(jié)存在的錨點和平面. */
    ARHitTestResultTypeExistingPlaneUsingExtent  = (1 << 4),
} NS_SWIFT_NAME(ARHitTestResult.ResultType);

/**
捕捉類型
 */
@property (nonatomic, readonly) ARHitTestResultType type;

/**
 3D虛擬物體與相機的距離(單位:米)
 */
@property (nonatomic, readonly) CGFloat distance;

/**
本地坐標矩陣(世界坐標指的是相機為場景原點的坐標踊餐,而每一個3D物體自身有一個場景,本地坐標就是相對于這個場景的坐標)類似于frame和bounds的區(qū)別
 */
@property (nonatomic, readonly) matrix_float4x4 localTransform;

/**
世界坐標矩陣
 */
@property (nonatomic, readonly) matrix_float4x4 worldTransform;

/**
 錨點(3D虛擬物體臀稚,在虛擬世界有一個位置,這個位置參數(shù)是SceneKit中的SCNVector3:三維矢量)三痰,而錨點anchor是這個物體在AR現(xiàn)實場景中的位置吧寺,是一個4x4的矩陣
 */
@property (nonatomic, strong, nullable, readonly) ARAnchor *anchor;

@end

<h2 id="1.7">1.7-ARLightEstimate</h2>

  • ARLightEstimate是一個燈光效果,它可以讓你的AR場景看起來更加的好

@interface ARLightEstimate : NSObject <NSCopying>

/**
燈光強度  范圍0-2000 默認1000
 */
@property (nonatomic, readonly) CGFloat ambientIntensity;

@end

<h2 id="1.8">1.8-ARPlaneAnchor</h2>

  • ARPlaneAnchor是ARAnchor的子類散劫,筆者稱之為平地錨點稚机。ARKit能夠自動識別平地,并且會默認添加一個錨點到場景中获搏,當(dāng)然要想看到真實世界中的平地效果赖条,需要我們自己使用SCNNode來渲染這個錨點
    • 錨點只是一個位置

/**
平地類型,目前只有一個常熙,就是水平面
 */
@property (nonatomic, readonly) ARPlaneAnchorAlignment alignment;

/**
3軸矢量結(jié)構(gòu)體纬乍,表示平地的中心點  x/y/z
 */
@property (nonatomic, readonly) vector_float3 center;

/**
3軸矢量結(jié)構(gòu)體,表示平地的大新阄馈(寬度和高度)  x/y/z
 */
@property (nonatomic, readonly) vector_float3 extent;

@end

<h2 id="1.9">1.9-ARPointCloud</h2>

  • ARPointCloud:點狀渲染云仿贬,主要用于渲染場景

@interface ARPointCloud : NSObject <NSCopying>

/**
 點的數(shù)量
 */
@property (nonatomic, readonly) NSUInteger count;

/**
每一個點的位置的集合(結(jié)構(gòu)體帶*表示的是結(jié)構(gòu)體數(shù)組)
 */
@property (nonatomic, readonly) const vector_float3 *points;

@end

<h2 id="1.10">1.10-ARSCNView</h2>

  • AR視圖,在第一小節(jié)筆者介紹過墓贿,ARKit支持3D的AR場景和2D的AR場景茧泪,ARSCNView是3D的AR場景視圖

    • 該類非常重要蜓氨,且API較多,將在后續(xù)小節(jié)介紹
  • 該類是整個ARKit框架中唯一兩個有代理的類其中之一

<h2 id="1.11">1.11-ARSession</h2>

  • AR會話队伟,它的作用已經(jīng)在前面小節(jié)中介紹穴吹,這里不再累述

    • 該類非常重要,且API較多嗜侮,將在后續(xù)小節(jié)介紹
  • 該類是整個ARKit框架中唯一兩個有代理的類其中之一

<h2 id="1.12">1.12-ARSessionConfiguration</h2>

  • ARSessionConfiguration會話追蹤配置刀荒,主要就是追蹤相機的配置
    • 注意:該類還有一個子類:ARWorldTrackingSessionConfiguration,它們在同一個API文件中

//會話追蹤配置類
@interface ARSessionConfiguration : NSObject <NSCopying>

/**
當(dāng)前設(shè)備是否支持棘钞,一般A9芯片以下設(shè)備不支持
 */
@property(class, nonatomic, readonly) BOOL isSupported;

/**
會話的對其方式缠借,這里的對其指的是3D世界的坐標。枚舉值見下方
 */
@property (nonatomic, readwrite) ARWorldAlignment worldAlignment;

/**
是否需要自適應(yīng)燈光效果宜猜,默認是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

} NS_SWIFT_NAME(ARSessionConfiguration.WorldAlignment);

/**
偵查類型
/
API_AVAILABLE(ios(11.0)) API_UNAVAILABLE(macos, watchos, tvos)
typedef NS_OPTIONS(NSUInteger, ARPlaneDetection) {
/
* 不偵查. */
ARPlaneDetectionNone = 0,

/** 平地偵查 */
ARPlaneDetectionHorizontal  = (1 << 0),

} NS_SWIFT_NAME(ARWorldTrackingSessionConfiguration.PlaneDetection);

<h2 id="1.13">1.13-ARSKView</h2>

  • ARSKView也是AR視圖叫乌,只不過他是2D的柴罐,由于2D比3D簡單很多,并且ARSKView基本與ARSCNView類似憨奸,所以這里不做重復(fù)介紹革屠。詳細內(nèi)容可參考ARSCNView
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市排宰,隨后出現(xiàn)的幾起案子似芝,更是在濱河造成了極大的恐慌,老刑警劉巖板甘,帶你破解...
    沈念sama閱讀 206,968評論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件党瓮,死亡現(xiàn)場離奇詭異,居然都是意外死亡盐类,警方通過查閱死者的電腦和手機寞奸,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,601評論 2 382
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來在跳,“玉大人枪萄,你說我怎么就攤上這事∮脖希” “怎么了呻引?”我有些...
    開封第一講書人閱讀 153,220評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長吐咳。 經(jīng)常有香客問我逻悠,道長元践,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,416評論 1 279
  • 正文 為了忘掉前任童谒,我火速辦了婚禮单旁,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘饥伊。我一直安慰自己象浑,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 64,425評論 5 374
  • 文/花漫 我一把揭開白布琅豆。 她就那樣靜靜地躺著愉豺,像睡著了一般。 火紅的嫁衣襯著肌膚如雪茫因。 梳的紋絲不亂的頭發(fā)上蚪拦,一...
    開封第一講書人閱讀 49,144評論 1 285
  • 那天,我揣著相機與錄音冻押,去河邊找鬼驰贷。 笑死,一個胖子當(dāng)著我的面吹牛洛巢,可吹牛的內(nèi)容都是我干的括袒。 我是一名探鬼主播,決...
    沈念sama閱讀 38,432評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼稿茉,長吁一口氣:“原來是場噩夢啊……” “哼锹锰!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起狈邑,我...
    開封第一講書人閱讀 37,088評論 0 261
  • 序言:老撾萬榮一對情侶失蹤城须,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后米苹,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,586評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡砰琢,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,028評論 2 325
  • 正文 我和宋清朗相戀三年蘸嘶,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片陪汽。...
    茶點故事閱讀 38,137評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡训唱,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出挚冤,到底是詐尸還是另有隱情况增,我是刑警寧澤,帶...
    沈念sama閱讀 33,783評論 4 324
  • 正文 年R本政府宣布训挡,位于F島的核電站澳骤,受9級特大地震影響歧强,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜为肮,卻給世界環(huán)境...
    茶點故事閱讀 39,343評論 3 307
  • 文/蒙蒙 一摊册、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧颊艳,春花似錦茅特、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,333評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽重斑。三九已至兵睛,卻和暖如春绸狐,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背寒矿。 一陣腳步聲響...
    開封第一講書人閱讀 31,559評論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留符相,地道東北人拆融。 一個月前我還...
    沈念sama閱讀 45,595評論 2 355
  • 正文 我出身青樓镜豹,卻偏偏與公主長得像,于是被迫代替她去往敵國和親蓝牲。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 42,901評論 2 345

推薦閱讀更多精彩內(nèi)容