Interface AddAssetOptions

interface AddAssetOptions {
    addToRoot?: boolean;
    autoCenter?: boolean;
    autoScale?: boolean;
    autoScaleRadius?: number;
    autoSetBackground?: boolean;
    autoSetEnvironment?: boolean;
    centerGeometries?: boolean;
    centerGeometriesKeepPosition?: boolean;
    clearSceneObjects?: boolean;
    disposeSceneObjects?: boolean;
    importConfig?: boolean;
    license?: string;
}

Hierarchy (view full)

Properties

addToRoot? autoCenter? autoScale? autoScaleRadius? autoSetBackground? autoSetEnvironment? centerGeometries? centerGeometriesKeepPosition? clearSceneObjects? disposeSceneObjects? importConfig? license?

Properties

Optional addToRoot

addToRoot?: boolean

Add directly to the RootScene object instead of RootScene.modelRoot

Default

false

Optional autoCenter

autoCenter?: boolean

Automatically center the object in the scene.

Default

false

Optional autoScale

autoScale?: boolean

Automatically scale the object according to its bounding box and the autoScaleRadius setting

Default

false

Optional autoScaleRadius

autoScaleRadius?: number

Radius to use for autoScale autoScale must be true for this to work.

Default

2

Optional autoSetBackground

autoSetBackground?: boolean

Automatically set any loaded image(ITexture) file as the scene background

Optional autoSetEnvironment

autoSetEnvironment?: boolean

Automatically set any loaded HDR, EXR file as the scene environment map

Default

true

Optional centerGeometries

centerGeometries?: boolean

Automatically center the geometries(pivots) in the object hierarchy before adding.

Default

false

Optional centerGeometriesKeepPosition

centerGeometriesKeepPosition?: boolean

This centers the geometry while keeping the world position, i.e the mesh(Object3D) positions will change. centerGeometries must be true for this to work.

Default

true

Optional clearSceneObjects

clearSceneObjects?: boolean

Clear the viewer scene objects before the new object is added. Same as disposeSceneObjects but does not dispose the objects.

Optional disposeSceneObjects

disposeSceneObjects?: boolean

Dispose all the scene objects before the new object is added. Same as clearSceneObjects but also disposes the objects.

Optional importConfig

importConfig?: boolean

any attached viewer config will be ignored if this is set to true

Default

true

Optional license

license?: string

Add a license to the object

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc