three-cad-viewer
    Preparing search index...

    Interface ViewerOptions

    Viewer options (includes studio mode configuration)

    interface ViewerOptions {
        axes?: boolean;
        axes0?: boolean;
        blackEdges?: boolean;
        centerGrid?: boolean;
        clipIntersection?: boolean;
        clipNormal0?: Vector3Tuple;
        clipNormal1?: Vector3Tuple;
        clipNormal2?: Vector3Tuple;
        clipObjectColors?: boolean;
        clipPlaneHelpers?: boolean;
        clipSlider0?: number;
        clipSlider1?: number;
        clipSlider2?: number;
        collapse?: number;
        control?: ControlType;
        grid?: [boolean, boolean, boolean];
        gridFontSize?: number;
        holroyd?: boolean;
        ortho?: boolean;
        panSpeed?: number;
        position?: Vector3Tuple | null;
        quaternion?: QuaternionTuple | null;
        rotateSpeed?: number;
        studio4kEnvMaps?: boolean;
        studioAOIntensity?: number;
        studioBackground?: StudioBackground;
        studioEnvIntensity?: number;
        studioEnvironment?: string;
        studioEnvRotation?: number;
        studioExposure?: number;
        studioShadowIntensity?: number;
        studioShadowSoftness?: number;
        studioTextureMapping?: StudioTextureMapping;
        studioToneMapping?: StudioToneMapping;
        tab?: ActiveTab;
        target?: Vector3Tuple | null;
        ticks?: number;
        timeit?: boolean;
        transparent?: boolean;
        up?: UpDirection;
        zoom?: number;
        zoomSpeed?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    axes? axes0? blackEdges? centerGrid? clipIntersection? clipNormal0? clipNormal1? clipNormal2? clipObjectColors? clipPlaneHelpers? clipSlider0? clipSlider1? clipSlider2? collapse? control? grid? gridFontSize? holroyd? ortho? panSpeed? position? quaternion? rotateSpeed? studio4kEnvMaps? studioAOIntensity? studioBackground? studioEnvIntensity? studioEnvironment? studioEnvRotation? studioExposure? studioShadowIntensity? studioShadowSoftness? studioTextureMapping? studioToneMapping? tab? target? ticks? timeit? transparent? up? zoom? zoomSpeed?

    Properties

    axes?: boolean

    Show X-, Y-, Z-axes (default: false)

    axes0?: boolean

    Show axes at [0,0,0] or at object center (default: false)

    blackEdges?: boolean

    Show edges in black instead of edgeColor (default: false)

    centerGrid?: boolean

    Center grid on object (default: false)

    clipIntersection?: boolean

    Use intersection clipping (default: false)

    clipNormal0?: Vector3Tuple

    Normal direction for clipping plane 0 (default: [-1, 0, 0])

    clipNormal1?: Vector3Tuple

    Normal direction for clipping plane 1 (default: [0, -1, 0])

    clipNormal2?: Vector3Tuple

    Normal direction for clipping plane 2 (default: [0, 0, -1])

    clipObjectColors?: boolean

    Use object colors for clipping (default: false)

    clipPlaneHelpers?: boolean

    Show clipping planes (default: false)

    clipSlider0?: number

    Clip slider 0 value (default: -1)

    clipSlider1?: number

    Clip slider 1 value (default: -1)

    clipSlider2?: number

    Clip slider 2 value (default: -1)

    collapse?: number

    Collapse level (default: 0)

    control?: ControlType

    Use OrbitControls or TrackballControls (default: "orbit")

    grid?: [boolean, boolean, boolean]

    Initial grid setting [xy, xz, yz] (default: [false, false, false])

    gridFontSize?: number

    Grid font size (default: 10)

    holroyd?: boolean

    Holroyd mode for controls (default: true)

    ortho?: boolean

    Use orthographic (true) or perspective camera (default: true)

    panSpeed?: number

    Pan speed (default: 1.0)

    position?: Vector3Tuple | null

    Camera position as 3-dim array

    quaternion?: QuaternionTuple | null

    Camera rotation as 4-dim quaternion [x,y,z,w]

    rotateSpeed?: number

    Rotation speed (default: 1.0)

    studio4kEnvMaps?: boolean

    Use 4K environment maps instead of 2K (default: false)

    studioAOIntensity?: number

    Ambient occlusion intensity, 0-3.0 (default: 0 = off)

    studioBackground?: StudioBackground

    Background mode (default: "environment")

    studioEnvIntensity?: number

    Environment map intensity, 0-1 (default: 0.5)

    studioEnvironment?: string

    Environment preset or custom HDR URL (default: "studio")

    studioEnvRotation?: number

    Environment map rotation in degrees, 0-360 (default: 0)

    studioExposure?: number

    Tone mapping exposure, 0-2 (default: 1.0)

    studioShadowIntensity?: number

    Shadow intensity, 0-1 (default: 0 = off)

    studioShadowSoftness?: number

    Shadow softness, 0-1 (default: 0.3)

    studioTextureMapping?: StudioTextureMapping

    Texture mapping mode: triplanar projection or parametric UVs (default: "triplanar")

    studioToneMapping?: StudioToneMapping

    Tone mapping algorithm (default: "neutral")

    tab?: ActiveTab

    Tab to land on after render (default: "tree", i.e. CAD mode). When set to a non-tree tab, the initial CAD paint is skipped so the user doesn't see a brief CAD-mode flicker before the target tab takes over. Especially noticeable for "studio" (async env-map load) and "zebra" (material swap).

    target?: Vector3Tuple | null

    Camera target

    ticks?: number

    Hint for the number of grid ticks (default: 10)

    timeit?: boolean

    Show timings in browser console (default: false)

    transparent?: boolean

    Show CAD object transparent (default: false)

    up?: UpDirection

    Up direction (default: "Z")

    zoom?: number

    Camera zoom value (default: 1)

    zoomSpeed?: number

    Zoom speed (default: 1.0)

    Settings

    Member Visibility

    On This Page

    Properties