Options
All
  • Public
  • Public/Protected
  • All
Menu

@sheencity/diva-sdk - v0.3.0

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

CssTime

CssTime: `${number}${CssTimeUnit}`

CSS 时间字面量类型。

see

https://developer.mozilla.org/en-US/docs/Web/CSS/time

CssTimeUnit

CssTimeUnit: "s" | "ms"

CSS 时间单位类型。

see

https://www.w3.org/TR/css-values-3/#time

CubicBezier

CubicBezier: readonly [p0: number, p1: number, p2: number, p3: number]

DeviceConfig

DeviceConfig: ModelConfig & { powerStatus: PowerStatus; signal?: DeviceControlSignal }

创建设备的选项。

DeviceControlSignal

DeviceControlSignal: Observable<DeviceControlSignalEvent>

DivaConstructorOptions

DivaConstructorOptions: DivaModeConstructorOptions | DivaAdapterConstructorOptions | DivaWebRtcConstructorOptions

DIVA 构造配置项。

DivaKeyframeInput

DivaKeyframeInput: PropertiesNullable<DivaKeyFrameOptions & AnimatableProperties>

DivaModeConstructorOptions

DivaModeConstructorOptions: DivaCloudModeConstructorOptions | DivaEmbeddedConstructorOptions

以工作模式形式构造 DIVA。

ElevatorControlSignal

ElevatorControlSignal: Observable<ElevatorSignalEvent>

电梯控制器信号。

EmissiveConfig

EmissiveConfig: ModelConfig & { emissionColor?: string; emissionStrength?: number; speed?: number }

GroupData

GroupData: { description: string | null; name: string | null; tag: string | null; transform: Matrix; type: string }

Type declaration

  • description: string | null
  • name: string | null
  • tag: string | null
  • transform: Matrix
  • type: string

Landings

Landings: Record<string, Vector3>

电梯停靠点定义类型。

type Landings = {
  [point: string]: Vector3
};

// 定义每个停靠点的名称与位置。
const landings: Landings = {
  F3: new Vector(0, 0, 9),
  F2: new Vector(0, 0, 6),
  F1: new Vector(0, 0, 0),
  B1: new Vector(0, 0, -3),
  B2: new Vector(0, 0, -6),
}

MarkerConfig

MarkerConfig: ModelConfig & { align?: "left" | "right" | "center"; autoSize?: boolean; backgroundColor?: string; border?: Border; content?: string; opacity?: number; title?: string }

MatrixTuple

MatrixTuple: [m00: number, m01: number, m02: number, m03: number, m10: number, m11: number, m12: number, m13: number, m20: number, m21: number, m22: number, m23: number, m30: number, m31: number, m32: number, m33: number]

表示转换矩阵的 16 元组。

ModelConfig

ModelConfig: ModelTransformConfig | ModelCoordScaleRotationConfig & { clickable?: boolean; group?: string; resource?: Resource; visible?: boolean } & EntityConfig

创建模型实例的设置。

ODLineConfig

ODLineConfig: ModelConfig & { angle?: number; color?: string; coords?: ODLineCoord; diameter?: number; emissive?: number; opacity?: number; speed?: number; style?: ODLineType; tiling?: number; xray?: boolean }

POI2DConfig

POI2DConfig: POIConfig & { lineLength?: number }

POIConfig

POIConfig: ModelConfig & { autoSize?: boolean; backgroundColor?: string; icon?: POIIcon; opacity?: number; title?: string }

QuaternionTuple

QuaternionTuple: [x: number, y: number, z: number, w: number]

以四元组形式表示的四元数

Spread

Spread<A>: A extends [infer L, ...infer R] ? SpreadTwo<L, Spread<R>> : unknown

Type parameters

  • A: readonly [...unknown[]]

Vector3Tuple

Vector3Tuple: [x: number, y: number, z: number]

以三元组形式表示的三维向量。

Variables

Const ease

ease: readonly [0.25, 0.1, 0.25, 1] = ...

表示时间函数 cubicBezier(0.25, 0.1, 0.25, 1.0)。 这个函数类似于 easeInOut，尽管它在开始时加速地更快，但在接近中间中， 加速已经开始变慢了。

图例

Const easeIn

easeIn: readonly [0.42, 0, 1, 1] = ...

表示时间函数 cubicBezier(0.42, 0.0, 1.0, 1.0)。 动画开始时缓慢，然后逐步加速，知道达到最后状态，动画突然停止。

图例

Const easeInOut

easeInOut: readonly [0.42, 0, 0.58, 1] = ...

表示时间函数 cubicBezier(0.42, 0.0, 0.58, 1.0)。 使用这个定时函数，动画开始的行为类似于 easeIn 函数， 动画结束时的行为类似于 easeOut 函数。

图例

Const easeOut

easeOut: readonly [0, 0, 0.58, 1] = ...

表示定时函数 cubicBezier(0.0, 0.0, 0.58, 1.0)。 动画开始很快，然后逐渐减慢，直到最终状态。

图例

Const linear

linear: readonly [0, 0, 1, 1] = ...

表示时间函数 cubicBezier(0.0, 0.0, 1.0, 1.0)。 使用这个定时函数，动画会以恒定的速度从初始状态过渡到结束状态。

图例

Functions

Const cssTimeToMs

  • cssTimeToMs(val: `${number}s` | `${number}ms`): number

  • 将 CSS 时间字面量转换为已毫秒表示的数值。

    Parameters

    • val: `${number}s` | `${number}ms`

      CSS 时间字面量

    Returns number

    对应时长的毫秒数

Const cubicBezier

  • cubicBezier(p0: number, p1: number, p2: number, p3: number): CubicBezier

  • 生成三次贝塞尔曲线参数。 p0、p1、p2、p3 四个点在平面（x 轴表示时间比率，y 轴表示过渡比率） 中定义了三次方贝塞尔曲线。曲线起始于 p0 走向 p1，并从 p2 的方向来到 p3。 一般不会经过 p1 或 p2；这两个点只是在提供方向信息。p0 和 p1 之间的间距， 决定了曲线在转而趋进 p2 之前，走向 p1 方向的长度有多长。

    see

    贝塞尔曲线工具

    Parameters

    • p0: number

      定义曲线起点，介于 0 到 1

    • p1: number

      定义曲线从 p0 点的来向

    • p2: number

      定义曲线到 p3 点的朝向

    • p3: number

      定义曲线终点，介于 0 到 1

    Returns CubicBezier