@aibee/owlly-navigation 1.0.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.hbs +8 -0
- package/README.md +168 -0
- package/lib/owlly-navigation.js +178 -0
- package/lib/owlly-navigation.js.map +1 -0
- package/package.json +72 -0
package/README.hbs
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# Owlly Navigation
|
|
2
|
+
|
|
3
|
+
## 配置说明
|
|
4
|
+
存在不同配置的项目,放到src/config文件夹下,在打包是配置到src/cofnig/config.js内。
|
|
5
|
+
|
|
6
|
+
## API文档
|
|
7
|
+
|
|
8
|
+
## Functions
|
|
9
|
+
|
|
10
|
+
<dl>
|
|
11
|
+
<dt><a href="#initVROnLine">initVROnLine(data)</a></dt>
|
|
12
|
+
<dd><p>初始化VR线上数据</p>
|
|
13
|
+
</dd>
|
|
14
|
+
<dt><a href="#initVROffLine">initVROffLine(jsonStr, offlinePath)</a></dt>
|
|
15
|
+
<dd><p>初始化VR线下数据</p>
|
|
16
|
+
</dd>
|
|
17
|
+
<dt><a href="#initVR">initVR(data, domContainer, options)</a></dt>
|
|
18
|
+
<dd></dd>
|
|
19
|
+
<dt><a href="#initPath">initPath(path, pathParams)</a></dt>
|
|
20
|
+
<dd><p>初始化路径</p>
|
|
21
|
+
</dd>
|
|
22
|
+
<dt><a href="#moveToPos">moveToPos(pos, selfDir, tdir)</a></dt>
|
|
23
|
+
<dd><p>移动到位置</p>
|
|
24
|
+
</dd>
|
|
25
|
+
<dt><a href="#moveToGisPos">moveToGisPos(pos, animate)</a></dt>
|
|
26
|
+
<dd><p>移动到gis位置</p>
|
|
27
|
+
</dd>
|
|
28
|
+
<dt><a href="#runPath">runPath(path, pathParams, onStatus)</a></dt>
|
|
29
|
+
<dd><p>初始化路径</p>
|
|
30
|
+
</dd>
|
|
31
|
+
<dt><a href="#runGisPath">runGisPath(path, pathParams, onStatus)</a></dt>
|
|
32
|
+
<dd><p>执行路径</p>
|
|
33
|
+
</dd>
|
|
34
|
+
<dt><a href="#testFunctionInit">testFunctionInit()</a></dt>
|
|
35
|
+
<dd><p>测试方法</p>
|
|
36
|
+
</dd>
|
|
37
|
+
</dl>
|
|
38
|
+
|
|
39
|
+
<a name="initVROnLine"></a>
|
|
40
|
+
|
|
41
|
+
## initVROnLine(data)
|
|
42
|
+
初始化VR线上数据
|
|
43
|
+
|
|
44
|
+
**Kind**: global function
|
|
45
|
+
|
|
46
|
+
| Param | Type |
|
|
47
|
+
| --- | --- |
|
|
48
|
+
| data | <code>\*</code> |
|
|
49
|
+
|
|
50
|
+
<a name="initVROffLine"></a>
|
|
51
|
+
|
|
52
|
+
## initVROffLine(jsonStr, offlinePath)
|
|
53
|
+
初始化VR线下数据
|
|
54
|
+
|
|
55
|
+
**Kind**: global function
|
|
56
|
+
|
|
57
|
+
| Param | Type | Description |
|
|
58
|
+
| --- | --- | --- |
|
|
59
|
+
| jsonStr | <code>\*</code> | {config: "singledata/zh_hy/Po3o8Yy95IbIMZAx.json"} |
|
|
60
|
+
| offlinePath | <code>string</code> | 离线路径 |
|
|
61
|
+
|
|
62
|
+
<a name="initVR"></a>
|
|
63
|
+
|
|
64
|
+
## initVR(data, domContainer, options)
|
|
65
|
+
**Kind**: global function
|
|
66
|
+
|
|
67
|
+
| Param | Type | Description |
|
|
68
|
+
| --- | --- | --- |
|
|
69
|
+
| data | <code>\*</code> | 数据 |
|
|
70
|
+
| domContainer | <code>HTMLElement</code> | dom容器 |
|
|
71
|
+
| options | <code>Object</code> \| <code>string</code> | 配置 |
|
|
72
|
+
| options.logLevel | <code>Number</code> | log等级 |
|
|
73
|
+
| options.offlinePath | <code>string</code> | 离线路径 |
|
|
74
|
+
|
|
75
|
+
<a name="initPath"></a>
|
|
76
|
+
|
|
77
|
+
## initPath(path, pathParams)
|
|
78
|
+
初始化路径
|
|
79
|
+
|
|
80
|
+
**Kind**: global function
|
|
81
|
+
|
|
82
|
+
| Param | Type |
|
|
83
|
+
| --- | --- |
|
|
84
|
+
| path | <code>Array.<Object></code> |
|
|
85
|
+
| path[].x; | <code>number</code> |
|
|
86
|
+
| path[].y; | <code>number</code> |
|
|
87
|
+
| path[].vr_id | <code>string</code> |
|
|
88
|
+
| pathParams | <code>Object</code> |
|
|
89
|
+
| pathParams.offset | <code>Object</code> |
|
|
90
|
+
| pathParams.offset.x; | <code>number</code> |
|
|
91
|
+
| pathParams.offset.y; | <code>number</code> |
|
|
92
|
+
| pathParams.color | <code>number</code> |
|
|
93
|
+
| pathParams.width | <code>number</code> |
|
|
94
|
+
| pathParams.image | <code>string</code> |
|
|
95
|
+
|
|
96
|
+
<a name="moveToPos"></a>
|
|
97
|
+
|
|
98
|
+
## moveToPos(pos, selfDir, tdir)
|
|
99
|
+
移动到位置
|
|
100
|
+
|
|
101
|
+
**Kind**: global function
|
|
102
|
+
|
|
103
|
+
| Param | Type | Description |
|
|
104
|
+
| --- | --- | --- |
|
|
105
|
+
| pos | <code>Object</code> | 位置 [pos.x](number) [pos.y](number) |
|
|
106
|
+
| selfDir | <code>Boolean</code> | 全景点自身方向 |
|
|
107
|
+
| tdir | <code>Object</code> | 方向 |
|
|
108
|
+
| tdir.x; | <code>number</code> | |
|
|
109
|
+
| tdir.y; | <code>number</code> | |
|
|
110
|
+
|
|
111
|
+
<a name="moveToGisPos"></a>
|
|
112
|
+
|
|
113
|
+
## moveToGisPos(pos, animate)
|
|
114
|
+
移动到gis位置
|
|
115
|
+
|
|
116
|
+
**Kind**: global function
|
|
117
|
+
|
|
118
|
+
| Param | Type | Description |
|
|
119
|
+
| --- | --- | --- |
|
|
120
|
+
| pos | <code>Object</code> | 位置 [pos.x](number) [pos.y](number) [pos.vr_id](number) |
|
|
121
|
+
| animate | <code>boolean</code> | 动画 |
|
|
122
|
+
|
|
123
|
+
<a name="runPath"></a>
|
|
124
|
+
|
|
125
|
+
## runPath(path, pathParams, onStatus)
|
|
126
|
+
初始化路径
|
|
127
|
+
|
|
128
|
+
**Kind**: global function
|
|
129
|
+
|
|
130
|
+
| Param | Type |
|
|
131
|
+
| --- | --- |
|
|
132
|
+
| path | <code>Array.<Object></code> |
|
|
133
|
+
| path[].x; | <code>number</code> |
|
|
134
|
+
| path[].y; | <code>number</code> |
|
|
135
|
+
| path[].vr_id | <code>string</code> |
|
|
136
|
+
| pathParams | <code>Object</code> |
|
|
137
|
+
| pathParams.offset | <code>Object</code> |
|
|
138
|
+
| pathParams.offset.x; | <code>number</code> |
|
|
139
|
+
| pathParams.offset.y; | <code>number</code> |
|
|
140
|
+
| pathParams.color | <code>number</code> |
|
|
141
|
+
| pathParams.width | <code>number</code> |
|
|
142
|
+
| pathParams.image | <code>string</code> |
|
|
143
|
+
| onStatus | <code>function</code> |
|
|
144
|
+
|
|
145
|
+
<a name="runGisPath"></a>
|
|
146
|
+
|
|
147
|
+
## runGisPath(path, pathParams, onStatus)
|
|
148
|
+
执行路径
|
|
149
|
+
|
|
150
|
+
**Kind**: global function
|
|
151
|
+
|
|
152
|
+
| Param | Type | Description |
|
|
153
|
+
| --- | --- | --- |
|
|
154
|
+
| path | <code>Array.<Object></code> | |
|
|
155
|
+
| path[].x; | <code>number</code> | |
|
|
156
|
+
| path[].y; | <code>number</code> | |
|
|
157
|
+
| path[].vr_id | <code>string</code> | |
|
|
158
|
+
| pathParams | <code>Object</code> | |
|
|
159
|
+
| pathParams.durTime | <code>number</code> | 间隔 |
|
|
160
|
+
| pathParams.animation | <code>number</code> | 动画 |
|
|
161
|
+
| onStatus | <code>function</code> | |
|
|
162
|
+
|
|
163
|
+
<a name="testFunctionInit"></a>
|
|
164
|
+
|
|
165
|
+
## testFunctionInit()
|
|
166
|
+
测试方法
|
|
167
|
+
|
|
168
|
+
**Kind**: global function
|