Interface BaseSceneProps

interface BaseSceneProps {
    backgroundColor?: number;
    backgroundImage?: string;
    camera2dSize?: Vec2;
    cameraPosition?: Vec2 | Vec3;
    commandMgr?: CommandManager;
    container: string;
    coordinateType?: "top" | "front" | "left";
    disableResize?: boolean;
    draggable?: boolean;
    frustumSize?: number;
    id: string;
    initialized?: ((sceneTool) => void);
    maxFPS?: number;
    onClickNothing?: ((event) => void);
    outputEncoding?: number;
    preserveDrawingBuffer?: boolean;
    renderFlag?: boolean;
    resizeFramebuffer?: boolean;
    resizeTo?: string | Window;
    resolution?: number;
    scalable?: boolean;
    skyBoxImages?: string[];
    transparent?: boolean;
    type?: symbol;
    viewport?: ViewportInfo;
}

Properties

backgroundColor? backgroundImage? camera2dSize? cameraPosition? commandMgr? container coordinateType? disableResize? draggable? frustumSize? id initialized? maxFPS? onClickNothing? outputEncoding? preserveDrawingBuffer? renderFlag? resizeFramebuffer? resizeTo? resolution? scalable? skyBoxImages? transparent? type? viewport?

Properties

Optional backgroundColor

backgroundColor?: number

画布背景色，使用十六进制。默认：0xffffff

Optional backgroundImage

backgroundImage?: string

画布背景图，优先级高于背景色

Optional camera2dSize

camera2dSize?: Vec2

2d 相机的尺寸（x是宽度、y是高度）单位：毫米

Optional cameraPosition

cameraPosition?: Vec2 | Vec3

相机的初始位置

Optional commandMgr

commandMgr?: CommandManager

处理本场景的 commandMgr

container

container: string

画布容器标识 多个不同 id 的场景可关联同一个容器/渲染器上下文

Optional coordinateType

coordinateType?: "top" | "front" | "left"

坐标系类型

Optional disableResize

disableResize?: boolean

禁用 resize

Optional draggable

draggable?: boolean

画布是否可拖拽。默认：true

Optional frustumSize

frustumSize?: number

视椎体的大小（高度），只供 3d 正交相机使用

id

id: string

用以标示当前场景的 ID 当多个不同 id 的场景关联到同一容器中时，可用于区分场景和隔离交互控制器

Optional initialized

initialized?: ((sceneTool) => void)

Type declaration

    • (sceneTool): void

    • 场景初始化完成的回调

      Parameters

      Returns void

Optional maxFPS

maxFPS?: number

最大帧率限制

Optional onClickNothing

onClickNothing?: ((event) => void)

Type declaration

    • (event): void

    • 点击场景未选中任何目标的回调

      Parameters

      Returns void

Optional outputEncoding

outputEncoding?: number

颜色输出模式 renderer.outputEncoding

Optional preserveDrawingBuffer

preserveDrawingBuffer?: boolean

保留绘制缓存数据，用来截图

Optional renderFlag

renderFlag?: boolean

渲染标志（用来打开或关闭渲染 ticker，若为 false，则当前帧不渲染）

Optional resizeFramebuffer

resizeFramebuffer?: boolean

resizeFramebuffer

Optional resizeTo

resizeTo?: string | Window

resizeTo 适配的 dom id 或元素引用

Optional resolution

resolution?: number

分辨率

Optional scalable

scalable?: boolean

画布是否可缩放。默认：true

Optional skyBoxImages

skyBoxImages?: string[]

天空盒背景图，只有 3d 下才有效，图片列表顺序 pos-x, neg-x, pos-y, neg-y, pos-z, neg-z

Optional transparent

transparent?: boolean

是否画布透明。默认：false

Optional type

type?: symbol

用以标示当前场景的类型

Optional viewport

viewport?: ViewportInfo

根视图容器参数（在一个 renderer 中渲染多个子视图并互相隔离时使用）

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc