ThreePipe
    Preparing search index...

    Interface AddRawOptions

    interface AddRawOptions {
        _testDataTextureComplete?: boolean;
        addToRoot?: boolean;
        autoCenter?: boolean;
        autoImportZipContents?: boolean;
        autoScale?: boolean;
        autoScaleRadius?: number;
        autoSetBackground?: boolean;
        autoSetEnvironment?: boolean;
        centerGeometries?: boolean;
        centerGeometriesKeepPosition?: boolean;
        clearSceneObjects?: boolean;
        disposeSceneObjects?: boolean;
        forceImporterReprocess?: boolean;
        generateMipmaps?: boolean;
        importConfig?: boolean;
        license?: string;
        processImported?: boolean;
        processRaw?: boolean;
        replaceCameras?: boolean;
        replaceLights?: boolean;
        replaceMaterials?: boolean;
        rootPath?: string;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    _testDataTextureComplete?: boolean

    default = false, if set to true, it will test if the data textures are complete. [internal use]

    addToRoot?: boolean

    Add directly to the RootScene object instead of RootScene.modelRoot

    false
    
    autoCenter?: boolean

    Automatically center the object in the scene.

    false
    
    autoImportZipContents?: boolean

    default = true, if true, the importer will automatically import the contents of zip files, if zip importer is registered.

    autoScale?: boolean

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

    false
    
    autoScaleRadius?: number

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

    2
    
    autoSetBackground?: boolean

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

    autoSetEnvironment?: boolean

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

    true
    
    centerGeometries?: boolean

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

    false
    
    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.

    true
    
    clearSceneObjects?: boolean

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

    disposeSceneObjects?: boolean

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

    forceImporterReprocess?: boolean

    default = false. If true, the importer will reprocess the imported objects, even if they are already processed.

    generateMipmaps?: boolean

    default = undefined, only used for textures

    importConfig?: boolean

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

    true
    
    license?: string

    Add a license to the object

    processImported?: boolean

    use processRaw instead

    processRaw?: boolean

    default = true, toggle to control the processing of the raw objects in the proecssRaw method

    replaceCameras?: boolean

    If true, the importer will replace any three.js camera instances with upgraded cameras default = true

    replaceLights?: boolean

    If true, the importer will replace any three.js light instances with upgraded lights default = true

    replaceMaterials?: boolean

    If true, the importer will replace any three.js material instances with upgraded materials default = true

    rootPath?: string

    internal use