You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A plane is any touchable surface discovered in the AR session.
@@ -18,11 +20,14 @@ When the user taps on a plane it is automatically saved and an index is sent bac
18
20
You can access the value using `event.planeId`.
19
21
It can be used to host a cloud anchor or to place objects on tap.
20
22
23
+
------------
21
24
22
25
### CloudAnchor
23
26
24
27
It is a simple structure containing the CloudAnchorId in the `event.anchorId` value.
25
28
29
+
------------
30
+
26
31
### FeatureMapQuality
27
32
28
33
The FeatureMapQuality is an indicator used to get sure there is enough quality in the environment scan previous to host an anchor.
@@ -36,35 +41,31 @@ It is a value from 0 to 2 indicating the quality:
36
41
You can access the value via `event.quality`
37
42
Host the anchor when the event returns at least 1.
38
43
44
+
------------
45
+
39
46
### VideoRecording
40
47
41
48
After `stopVideoRecording` is called (`startVideoRecording` must be called first), the video is copied into storage and its path is returned when the promise fulfills.
42
49
43
50
You can get the path via `response.path`
44
51
52
+
------------
45
53
46
54
### Screenshot
47
55
48
56
When `takeScreenshot` is called, the session's current view is copied into a bitmap and saved as a JPEG image. When the promise fulfills you can access the image via `response.path`
49
57
58
+
------------
50
59
51
60
### Model
52
61
53
62
The `addObject` method is used to insert a renderable into scene, it supports a `Model` object described as follows:
54
63
55
-
##### name
56
-
57
-
It must be an URL pointing to a glb asset.
58
-
59
-
##### anchorId
60
-
61
-
It can be a CloudAnchorId or a PlaneId (returned by onTapPlane)
62
-
63
-
##### isCloudAnchor
64
-
65
-
`boolean`, if true then the `anchorId` value will be taken as a CloudAnchorId and the session will attempt to resolve it, triggering `onAnchorResolve` if succeed.
64
+
-**name**: It must be an URL pointing to a glb asset.
65
+
-**anchorId**: It can be a CloudAnchorId or a PlaneId (returned by onTapPlane)
66
+
-**isCloudAnchor**: `boolean`, if true then the `anchorId` value will be taken as a CloudAnchorId and the session will attempt to resolve it, triggering `onAnchorResolve` if succeed. Otherwise, if `false` , `anchorId` will be taken as `Plane` and the object will be attached to it.
66
67
67
-
Otherwise, if `false` , `anchorId` will be taken as `Plane` and the object will be attached to it.
68
+
------------
68
69
69
70
### LocationMarker
70
71
@@ -73,22 +74,12 @@ There are two types of tags currently supported, showing a label or a simple one
73
74
74
75
The location marker structure is:
75
76
76
-
##### title
77
+
-**title**: `String` , it is the label to be shown by the marker.
78
+
-**lat**: `Double`, the latitude value.
79
+
-**lng**: `Double`, the longitude value.
80
+
-**isAnchor**: `boolean`, if `false` the title is shown in the marker, if `true` then the icon marker is used.
77
81
78
-
`String` , it is the label to be shown by the marker.
79
-
80
-
##### lat
81
-
82
-
`Double`, the latitude value.
83
-
84
-
##### lng
85
-
86
-
`Double`, the longitude value.
87
-
88
-
##### isAnchor
89
-
90
-
`boolean`, if `false` the title is shown in the marker, if `true` then the icon marker is used,
82
+
------------
91
83
92
84
### CloudAnchorId
93
-
94
85
A `String` value returned by the `onAnchorHost` event, you can use it to resolve the same anchor lately or share it with friends to get the same experience.
0 commit comments