vrtalk-web-sdk 0.1.13 → 0.1.15

package/dist/src/core/vrkit-core.d.ts

@@ -1,5 +1,5 @@
 import type { VKServiceRegion } from '../define/vk-service-region-define';
-import { VKVRInstance } from '../model/vk-vr-instance';
+import { VKVRInstance } from '../model/core/vk-vr-instance';
 export declare class VRKitCore {
     private static initLock;
     private serviceRegion;
@@ -34,7 +34,8 @@ export declare class VRKitCore {
     createVRInstance(baseUrl: string, modelId: string, shareData: string): VKVRInstance;
     /**
      * 初始化vrsdk
-     * @param modelId
+     * @param baseUrl 基础url
+     * @param modelId 模型id
      * @param shareData
      * @param secretKey
      */

package/dist/src/index.d.ts

@@ -1,8 +1,8 @@
 import { VRKitCore } from './core/vrkit-core';
 import type { VKServiceRegion } from './define/vk-service-region-define';
-import { VKVRInstance } from './model/vk-vr-instance';
-export { VKEventParamsVRLoadDone, VKEventParamsVRMeasurementModeState, VKEventParamsVRHotpotsActive, VKEventParamsVRViewModeChanged, VKEventParamsVROperateData, VKEventParamsVRInternalMediaData, VKEventParamsVRInternalMediaSerializeData } from './model/vk-event-params';
-export { VKVRInstance } from './model/vk-vr-instance';
+import { VKVRInstance } from './model/core/vk-vr-instance';
+export { VKEventParamsVRLoadDone, VKEventParamsVRMeasurementModeState, VKEventParamsVRHotpotsActive, VKEventParamsVRViewModeChanged, VKEventParamsVROperateData, VKEventParamsVRInternalMediaData, VKEventParamsVRInternalMediaSerializeData } from './model/core/vk-event-params';
+export { VKVRInstance } from './model/core/vk-vr-instance';
 export { VKVRInternalMediaType } from './define/vk-vr-internal-media-type';
 export * from './model';
 export * from './define';
@@ -18,9 +18,10 @@ export default class VRKit {
     static initEditorSDK(region: VKServiceRegion, appId: string, secretKey: string, userId: string, userName: string): Promise<VRKitCore>;
     /**
      * 通过密码初始化sdk
+     * @param baseUrl
      * @param modelId
      * @param shareData
      * @param secretKey
      */
-    static initVRKit(baseUrl: string, modelId: string, shareData: string, secretKey: string): VKVRInstance;
+    static init(baseUrl: string, modelId: string, shareData: string, secretKey: string): VKVRInstance;
 }

package/dist/src/model/broadcast/broadcast-signal.d.ts

@@ -1,7 +1,7 @@
 /**
  * 广播信号
  */
-export declare class BroadcastSignal {
+export declare abstract class BroadcastSignal {
     id: string;
     channelName: string;
     tag: string;

package/dist/src/model/broadcast/index.d.ts

@@ -1,5 +1,4 @@
 export * from './broadcast-signal';
-export * from './broadcast-signal-group';
 export * from './broadcast-signal-sys-show-web-view';
 export * from './broadcast-signal-sys-show-content-card';
 export * from './broadcast-signal-sys-change-image-component-image';

package/dist/src/model/core/index.d.ts

@@ -0,0 +1,8 @@
+export * from './vk-command-data-package';
+export * from './vk-event-callback';
+export * from './vk-event-data-package';
+export * from './vk-event-params';
+export * from './vk-event-registry';
+export * from './vk-vr-hotpots-data';
+export * from './vk-vr-instance';
+export * from './vk-vr-tour';

package/dist/src/model/{vk-event-callback.d.ts → core/vk-event-callback.d.ts}

@@ -1,5 +1,5 @@
-import type { VKEventParamsVRHotpotsActive, VKEventParamsVRLoadDone, VKEventParamsVRMeasurementModeState, VKEventParamsVROperateData, VKEventParamsVRViewModeChanged, VKEventParamsVRInternalMediaData, VKEventParamsVRInternalMediaSerializeData } from '../model/vk-event-params';
-import { VKEventParamsVRDeepLink, VKEventParamsVRScreenShot } from '../model/vk-event-params';
+import type { VKEventParamsVRHotpotsActive, VKEventParamsVRLoadDone, VKEventParamsVRMeasurementModeState, VKEventParamsVROperateData, VKEventParamsVRViewModeChanged, VKEventParamsVRInternalMediaData, VKEventParamsVRInternalMediaSerializeData } from './vk-event-params';
+import { VKEventParamsVRDeepLink, VKEventParamsVRScreenShot } from './vk-event-params';
 /**
  * 回调事件:页面准备完成
  */

package/dist/src/model/{vk-event-data-package.d.ts → core/vk-event-data-package.d.ts}

@@ -1,4 +1,4 @@
-import type { VKEventType } from '../define/vk-event-type-define';
+import type { VKEventType } from '../../define/vk-event-type-define';
 export declare class VKEventDataPackage {
     eventToken: string;
     eventType: VKEventType;

package/dist/src/model/{vk-event-params.d.ts → core/vk-event-params.d.ts}

@@ -1,5 +1,5 @@
-import VKVRHotpotsData from '../model/vk-vr-hotpots-data';
-import type { VRViewMode } from '../define/vk-vr-view-mode-define';
+import VKVRHotpotsData from './vk-vr-hotpots-data';
+import type { VRViewMode } from '../../define/vk-vr-view-mode-define';
 /**
  * 回调参数：VR加载完成
  */

package/dist/src/model/{vk-event-registry.d.ts → core/vk-event-registry.d.ts}

@@ -1,6 +1,6 @@
-import type { EventCallbackPageLoadComplete, EventCallbackVRHotpotsActive, EventCallbackVRHotpotsClose, EventCallbackVRLoadDone, EventCallbackVRLoadStart, EventCallbackVRMeasurementModeState, EventCallbackVROperateData, EventCallbackVRTourEnd, EventCallbackVRInternalMediaData, EventCallbackVRViewModeChanged, EventCallbackVRInternalMediaSerializeData, EventCallbackVRScreenShot } from '../model/vk-event-callback';
-import type { VKVRInstance } from '../model/vk-vr-instance';
-import { EventCallbackVRDeepLink } from "../model/vk-event-callback";
+import type { EventCallbackPageLoadComplete, EventCallbackVRHotpotsActive, EventCallbackVRHotpotsClose, EventCallbackVRLoadDone, EventCallbackVRLoadStart, EventCallbackVRMeasurementModeState, EventCallbackVROperateData, EventCallbackVRTourEnd, EventCallbackVRInternalMediaData, EventCallbackVRViewModeChanged, EventCallbackVRInternalMediaSerializeData, EventCallbackVRScreenShot } from './vk-event-callback';
+import type { VKVRInstance } from './vk-vr-instance';
+import { EventCallbackVRDeepLink } from "./vk-event-callback";
 export declare class VKEventRegistry {
     private vrInstance;
     private callbackMapping;

package/dist/src/model/{vk-vr-instance.d.ts → core/vk-vr-instance.d.ts}

@@ -1,6 +1,6 @@
-import { VKEventRegistry } from '../model/vk-event-registry';
-import type { VKVRTour } from '../model/vk-vr-tour';
-import type { VRViewMode } from '../define/vk-vr-view-mode-define';
+import { VKEventRegistry } from './vk-event-registry';
+import type { VKVRTour } from './vk-vr-tour';
+import type { VRViewMode } from '../../define/vk-vr-view-mode-define';
 import { VRInternalMedia } from '@/define/vk-vr-internal-media-type';
 export declare class VKVRInstance {
     private readonly VRElement;

package/dist/src/model/general/camera-pose.d.ts

@@ -0,0 +1,25 @@
+import { Vector2, Vector3 } from '../general/vector';
+export declare type CameraMode = 'FLOOR_PLAN' | 'PANORAMA' | '3D';
+/**
+ * sweep模式下的相机姿态
+ */
+export declare class CameraPosePanorama {
+    sweepId: string;
+    rotation: Vector3;
+    zoom: number;
+}
+/**
+ * 3D模式下的相机姿态
+ */
+export declare class CameraPose3d {
+    position: Vector3;
+    rotation: Vector2;
+}
+/**
+ * 户型图模式下的相机姿态
+ * 有待调研，目前没实现
+ */
+export declare class CameraPoseFloorPlan {
+    position: Vector3;
+    zoom: number;
+}

package/dist/src/model/general/chroma-key-settings.d.ts

@@ -0,0 +1,5 @@
+import { Color } from '../general/color';
+export declare class ChromaKeySettings extends Color {
+    enabled: boolean;
+    tolerance: number;
+}

package/dist/src/model/general/color.d.ts

@@ -0,0 +1,42 @@
+/**
+ * RGB颜色构建器
+ */
+export declare class ColorBuilder {
+    /**
+     * 通过三种颜色值创建一个RGB颜色
+     * @param r 红色值
+     * @param g 绿色值
+     * @param b 蓝色值
+     */
+    static createColorRgb(r: number, g: number, b: number): Color;
+    /**
+     * 通过三种颜色值创建一个RGBA颜色
+     * @param r 红色值
+     * @param g 绿色值
+     * @param b 蓝色值
+     * @param a 透明度
+     */
+    static createColorRgba(r: number, g: number, b: number, a: number): Color;
+    /**
+     * 通过颜色字符串创建一个RGBA颜色
+     * 支持的颜色字符串格式有：
+     * 1. #RRGGBBAA
+     * 2. #RGBA
+     * 3. #RRGGBB: 如果没有a那么会默认为1tl
+     * 4. #RGB: 如果没有a那么会默认为1
+     * 5. rgba(r, g, b, a)
+     * 6. rgb(r, g, b)：如果没有a那么会默认为1
+     * @param colorStr 颜色字符串
+     */
+    static createColorByStr(colorStr: string): Color;
+}
+/**
+ * 颜色
+ * 支持RGBA颜色
+ */
+export declare class Color {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}

package/dist/src/model/general/hover-border-settings.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 鼠标悬浮边框设置选项设置
+ */
+export declare class HoverBorderSettings {
+    enabled: boolean;
+    hoverBorderColor: import("../general/color").Color;
+    borderWidth: number;
+}

package/dist/src/model/general/index.d.ts

@@ -0,0 +1,6 @@
+export * from './camera-pose';
+export * from './chroma-key-settings';
+export * from './color';
+export * from './hover-border-settings';
+export * from './media-data';
+export * from './vector';

package/dist/src/model/general/media-data.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 媒体数据 - 视频
+ */
+export declare class MediaVideoData {
+    name: string;
+    src: string;
+    aspectRatio: number;
+}
+/**
+ * 媒体数据 - 图片
+ */
+export declare class MediaImageData {
+    name: string;
+    src: string;
+    aspectRatio: number;
+}
+/**
+ * 媒体数据 - 音频
+ */
+export declare class MediaAudioData {
+    name: string;
+    src: string;
+    lrcSrc: string;
+}

package/dist/src/model/general/vector.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 三维向量
+ */
+export declare class Vector3 {
+    x: number;
+    y: number;
+    z: number;
+    constructor(x: number, y: number, z: number);
+}
+/**
+ * 二维向量
+ */
+export declare class Vector2 {
+    x: number;
+    y: number;
+    constructor(x: number, y: number);
+}

package/dist/src/model/index.d.ts

@@ -1,2 +1,5 @@
 export * from './broadcast';
-export * from './trigger';
+export * from './core';
+export * from './general';
+export * from './vr';
+export * from './vr-component';

package/dist/src/model/vr/index.d.ts

@@ -0,0 +1,15 @@
+export * from './vr-audio';
+export * from './vr-content-card';
+export * from './vr-content-data';
+export * from './vr-cover-settings';
+export * from './vr-floor';
+export * from './vr-fov';
+export * from './vr-function';
+export * from './vr-function-trigger';
+export * from './vr-layer';
+export * from './vr-light';
+export * from './vr-map-settings';
+export * from './vr-marker';
+export * from './vr-player-settings';
+export * from './vr-sweep';
+export * from './vr-view';

package/dist/src/model/vr/vr-audio.d.ts

@@ -0,0 +1,21 @@
+/**
+ * VR音频数据
+ */
+export declare class VrAudio {
+    id: string;
+    name: string;
+    description: string;
+    audioSrc: string;
+    lyricSrc: string;
+    coverSrc: string;
+    duration: number;
+}
+/**
+ * VR音频列表
+ */
+export declare class VrAudioList {
+    id: string;
+    name: string;
+    description: string;
+    audioList: VrAudio[];
+}

package/dist/src/model/vr/vr-content-card.d.ts

@@ -0,0 +1,26 @@
+import { VrFunctionTrigger } from '../vr/vr-function-trigger';
+export declare type VrContentCardModuleType = 'video' | 'image' | 'audio' | 'link';
+/**
+ * VR内容卡片
+ */
+export declare class VrContentCard {
+    id: string;
+    name: string;
+    richText: string;
+    modules: VrContentCardModule[];
+    actionButtons: VrContentCardActionButton[];
+}
+/**
+ * VR内容卡片模块
+ */
+export declare class VrContentCardModule {
+    name: string;
+    type: VrContentCardModuleType;
+}
+/**
+ * VR内容卡片事件按钮
+ */
+export declare class VrContentCardActionButton {
+    name: string;
+    trigger: VrFunctionTrigger;
+}

package/dist/src/model/vr/vr-content-data.d.ts

@@ -0,0 +1,35 @@
+import { VrFov } from '../vr/vr-fov';
+import { VrContentCard } from '../vr/vr-content-card';
+import { VrLight } from '../vr/vr-light';
+import { VrLayer } from '../vr/vr-layer';
+import { VrMarkerGroup } from '../vr/vr-marker';
+import { VrSweep } from '../vr/vr-sweep';
+import { VrAudioList } from '../vr/vr-audio';
+import { VrContentMenuSettings, VrInfoTemplateSettings, VrPlayerUiSettings } from '../vr/vr-player-settings';
+import { VrMapSettings } from '../vr/vr-map-settings';
+import { VrCoverSettings } from '../vr/vr-cover-settings';
+import { VrView } from '../vr/vr-view';
+import { VrFunction } from '../vr/vr-function';
+/**
+ * VR内容数据
+ */
+export declare class VrContentData {
+    version: 10000;
+    vrCoverSettings: VrCoverSettings;
+    vrPlayerUiSettings: VrPlayerUiSettings;
+    vrContentMenuSettings: VrContentMenuSettings;
+    vrInfoTemplateSettings: VrInfoTemplateSettings;
+    mapSettings: VrMapSettings;
+    vrFovList: VrFov[];
+    vrContentCardList: VrContentCard[];
+    vrLightList: VrLight[];
+    vrLayerList: VrLayer[];
+    vrViewList: VrView[];
+    sweepMarkList: VrMarkerGroup[];
+    componentMarkList: VrMarkerGroup[];
+    sweepList: VrSweep[];
+    audioCenter: VrAudioList[];
+    vrFunctionPool: {
+        [index: string]: VrFunction;
+    };
+}

package/dist/src/model/vr/vr-cover-settings.d.ts

@@ -0,0 +1,66 @@
+/**
+ * VR封面背景类型
+ */
+export declare type VrCoverBackgroundType = 'video' | 'image';
+/**
+ * VR封面背景类型定义
+ */
+export declare class VrCoverBackgroundTypeDefine {
+    static VIDEO: VrCoverBackgroundType;
+    static IMAGE: VrCoverBackgroundType;
+}
+/**
+ * VrCoverBackgroundFitType 封面背景填充类型
+ *
+ * 值           | 宽高比保持 | 容器是否填满 | 可能裁剪 | 典型场景
+ * ---------------------------------------------------------------------
+ * fill         | 否         | 是           | 否       | 填充容器，忽略内容宽高比
+ * contain      | 是         | 否           | 否       | 显示完整内容，可能会留白
+ * cover        | 是         | 是           | 是       | 背景铺满容器，适当裁剪内容
+ * none         | 是         | 否           | 否       | 保持原始尺寸内容
+ * scale-down   | 是         | 否           | 否       | 在 'none' 和 'contain' 之间灵活调整
+ */
+export declare type VrCoverBackgroundFitType = 'fill' | 'contain' | 'cover' | 'none' | 'scale-down';
+/**
+ * VR封面按钮填充类型定义
+ */
+export declare class VrCoverBackgroundFitTypeDefine {
+    static FILL: VrCoverBackgroundFitType;
+    static CONTAIN: VrCoverBackgroundFitType;
+    static COVER: VrCoverBackgroundFitType;
+    static NONE: VrCoverBackgroundFitType;
+    static SCALE_DOWN: VrCoverBackgroundFitType;
+}
+/**
+ * 封面按钮类型
+ * play: 系统默认的播放键样式
+ * text: 文字按钮
+ * image: 自定义图片按钮
+ */
+export declare type VrCoverButtonType = 'play' | 'text' | 'image';
+/**
+ * 封面按钮类型定义
+ */
+export declare class VrCoverButtonTypeDefine {
+    static PLAY: VrCoverButtonType;
+    static TEXT: VrCoverButtonType;
+}
+/**
+ * VR封面设置
+ */
+export declare class VrCoverSettings {
+    enabledCover: boolean;
+    coverImagePcSrc: string;
+    coverVideoSrc: string;
+    coverBackgroundType: VrCoverBackgroundType;
+    coverButtonType: VrCoverBackgroundFitType;
+    coverTitle: string;
+    coverDescription: string;
+    enabledEnterVrButton: boolean;
+    enterVrButtonType: VrCoverButtonType;
+    enterButtonBackgroundColor: import("../general/color").Color;
+    enterButtonForegroundColor: import("../general/color").Color;
+    enterButtonShadowColor: import("../general/color").Color;
+    enabledTextButton: boolean;
+    textButtonContent: string;
+}

package/dist/src/model/vr/vr-floor.d.ts

@@ -0,0 +1,17 @@
+import { VrFunctionTrigger } from '../vr/vr-function-trigger';
+/**
+ * VR楼层
+ */
+export declare class VrFloor {
+    id: string;
+    name: string;
+    sequence: number;
+    triggerSettings: VrFloorTriggerSettings;
+}
+/**
+ * VR楼层i触发器设置
+ */
+export declare class VrFloorTriggerSettings {
+    enterFloor: VrFunctionTrigger;
+    leaveFloor: VrFunctionTrigger;
+}

package/dist/src/model/vr/vr-fov.d.ts

@@ -0,0 +1,10 @@
+/**
+ * VR视角
+ */
+export declare class VrFov {
+    id: string;
+    name: string;
+    src: string;
+    showInList: boolean;
+    cameraMode: 'PANORAMA' | 'D3' | 'FLOOR_PLAN';
+}

package/dist/src/model/vr/vr-function-trigger.d.ts

@@ -0,0 +1,7 @@
+/**
+ * VR事件
+ */
+export declare class VrFunctionTrigger {
+    id: string;
+    functionId: string;
+}

package/dist/src/model/vr/vr-function.d.ts

@@ -0,0 +1,9 @@
+/**
+ * VR函数
+ */
+export declare class VrFunction {
+    id: string;
+    name: string;
+    data: string;
+    code: string;
+}

package/dist/src/model/vr/vr-layer.d.ts

@@ -0,0 +1,11 @@
+import { VrComponentData } from '../vr-component/vr-component-data';
+/**
+ * VR图层
+ */
+export declare class VrLayer {
+    id: string;
+    name: string;
+    visible: boolean;
+    children: VrLayer[];
+    components: VrComponentData[];
+}

package/dist/src/model/vr/vr-light.d.ts

@@ -0,0 +1,37 @@
+import { Vector3 } from '../general/vector';
+export declare type VrLightType = 'ambient' | 'directional' | 'point';
+/**
+ * 灯光配置
+ */
+export declare abstract class VrLight {
+    id: string;
+    type: VrLightType;
+    color: import("../general/color").Color;
+    enabled: boolean;
+    name: string;
+    intensity: number;
+    floorId: string;
+}
+/**
+ * 环境光
+ */
+export declare class VrLightAmbient extends VrLight {
+    type: VrLightType;
+}
+/**
+ * 平行光
+ */
+export declare class VrLightDirectional extends VrLight {
+    type: VrLightType;
+    position: Vector3;
+    target: Vector3;
+}
+/**
+ * 点光源
+ */
+export declare class VrLightPoint extends VrLight {
+    type: VrLightType;
+    position: Vector3;
+    distance: number;
+    decay: number;
+}

package/dist/src/model/vr/vr-map-settings.d.ts

@@ -0,0 +1,19 @@
+/**
+ * VR地图设置
+ */
+export declare class VrMapSettings {
+    enabled: boolean;
+    floorMapSettings: VrFloorMapSettings;
+}
+/**
+ * VR楼层地图设置
+ */
+export declare class VrFloorMapSettings {
+    floorId: string;
+    mapImageSrc: string;
+    widthScale: number;
+    heightScale: number;
+    horizontalOffset: number;
+    verticalOffset: number;
+    rotation: number;
+}

package/dist/src/model/vr/vr-marker.d.ts

@@ -0,0 +1,21 @@
+/**
+ * VR标记
+ * 可以为点位、或者元素（2D图片、3D模型等）打上标记，数据分析时候可以作为分组依据
+ */
+export declare class VrMarker {
+    id: string;
+    name: string;
+    description: string;
+    color: import("../general/color").Color;
+}
+/**
+ * VR标记组
+ * 包含多个标记
+ */
+export declare class VrMarkerGroup {
+    id: string;
+    name: string;
+    description: string;
+    color: import("../general/color").Color;
+    markers: VrMarker[];
+}

package/dist/src/model/vr/vr-player-settings.d.ts

@@ -0,0 +1,34 @@
+/**
+ * VR播放器UI界面设置
+ */
+export declare class VrPlayerUiSettings {
+    enabledShare: boolean;
+    enabledFullScreen: boolean;
+    enabledSceneBtn: boolean;
+    enabledFovBtn: boolean;
+    enabledD3ModeBtn: boolean;
+    enabledFloorPlanModeBtn: boolean;
+    enabledFloorSelectBtn: boolean;
+    enabledMeasurementBtn: boolean;
+}
+/**
+ * VR内容菜单设置
+ */
+export declare class VrContentMenuSettings {
+    enabled: boolean;
+}
+/**
+ * VR信息模板设置
+ */
+export declare class VrInfoTemplateSettings {
+    enabledVrInfoTemplate: boolean;
+    vrInfoTemplateDataKey: string;
+    vrInfoTemplateItemValueList: VrInfoTemplateItemValue[];
+}
+/**
+ * VR信息模板展示的数据
+ */
+export declare class VrInfoTemplateItemValue {
+    templateItemDataKey: string;
+    templateItemValue: string;
+}

package/dist/src/model/vr/vr-sweep.d.ts

@@ -0,0 +1,48 @@
+import { Vector3 } from '../general/vector';
+import { VrFunctionTrigger } from '../vr/vr-function-trigger';
+/**
+ * VR扫描
+ */
+export declare class VrSweep {
+    id: string;
+    alignmentType: VrSweepAlignment;
+    enabled: boolean;
+    floorId: string;
+    neighbors: string[];
+    placementType: VrSweepPlacementType;
+    position: Vector3;
+    rotation: Vector3;
+    triggerSettings: VrSweepTriggerSettings;
+}
+/**
+ * VR扫描触发器设置
+ */
+export declare class VrSweepTriggerSettings {
+    onEnter: VrFunctionTrigger;
+    onLeave: VrFunctionTrigger;
+}
+/**
+ * 扫描对齐方式
+ * aligned: 已与场景模型对齐
+ * unaligned: 尚未与场景对齐
+ */
+export declare type VrSweepAlignment = 'aligned' | 'unaligned';
+/**
+ * 扫描对齐方式
+ */
+export declare class VrSweepAlignmentDefine {
+    static readonly ALIGNED: VrSweepAlignment;
+    static readonly UNALIGNED: VrSweepAlignment;
+}
+/**
+ * 扫描放置方式
+ */
+export declare type VrSweepPlacementType = 'auto' | 'manual' | 'unplaced';
+/**
+ * 扫描放置方式
+ */
+export declare class VrSweepPlacementTypeDefine {
+    static readonly AUTO: VrSweepPlacementType;
+    static readonly MANUAL: VrSweepPlacementType;
+    static readonly UNPLACED: VrSweepPlacementType;
+}