ThreePipe
    Preparing search index...

    Interface IObject3DUserData

    interface IObject3DUserData {
        __autoBubbleToParentEvents?: string[];
        __gltfAsset?: {};
        __gltfExtras?: Record<string, any>;
        __importData?: any;
        __keepShadowDef?: boolean;
        __needsSourceBuffer?: boolean;
        __sourceBlob?: IFile;
        __sourceBuffer?: ArrayBuffer;
        _originalMaterial?:
            | IMaterial<IMaterialEventMap>
            | IMaterial<IMaterialEventMap>[];
        _variantMaterials?: Record<string, { material: IMaterial }>;
        animationObjects?: AnimationObject<any>[];
        autoCentered?: boolean;
        autoRegisterInManager?: boolean;
        autoScaled?: boolean;
        autoScaleRadius?: number;
        autoUpdateParent?: boolean;
        bboxVisible?: boolean;
        constraints?: ObjectConstraint<keyof ConstraintPropsTypes>[];
        dispose?: any;
        disposeOnIdle?: boolean;
        excludeFromExport?: boolean;
        geometriesCentered?: boolean;
        gltfAnim_SyncMaxDuration?: boolean;
        isCentered?: boolean;
        license?: string;
        physicsMass?: number;
        pseudoCentered?: boolean;
        rootPath?: string;
        rootPathOptions?: Record<string, any>;
        rootPathRefresh?: boolean;
        rootSceneModelRoot?: boolean;
        setDirty?: any;
        setGeometry?: any;
        setMaterial?: any;
        sProperties?: string[];
        TransformAnimationPlugin?: { transforms: TSavedTransform[] };
        transformControls?: {
            lockProps?: string[];
            mode?: "translate" | "rotate" | "scale";
            rotationSnap?: number;
            scaleSnap?: number;
            showX?: boolean;
            showY?: boolean;
            showZ?: boolean;
            space?: "world" | "local";
            translationSnap?: number;
        };
        userSelectable?: boolean;
        uuid?: string;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    __autoBubbleToParentEvents? __gltfAsset? __gltfExtras? __importData? __keepShadowDef? __needsSourceBuffer? __sourceBlob? __sourceBuffer? _originalMaterial? _variantMaterials? animationObjects? autoCentered? autoRegisterInManager? autoScaled? autoScaleRadius? autoUpdateParent? bboxVisible? constraints? dispose? disposeOnIdle? excludeFromExport? geometriesCentered? gltfAnim_SyncMaxDuration? isCentered? license? physicsMass? pseudoCentered? rootPath? rootPathOptions? rootPathRefresh? rootSceneModelRoot? setDirty? setGeometry? setMaterial? sProperties? TransformAnimationPlugin? transformControls? userSelectable? uuid?

    Properties

    Optional__autoBubbleToParentEvents

    __autoBubbleToParentEvents?: string[]

    Events that should be bubbled to parent root without the need to set bubbleToParent in the event. todo: remove support for this

    Optional__gltfAsset

    __gltfAsset?: {}

    Optional__gltfExtras

    __gltfExtras?: Record<string, any>

    Optional__importData

    __importData?: any

    extra arbitrary data saved by the importer that can be used by the plugins (like gltf material variants)

    Optional__keepShadowDef

    __keepShadowDef?: boolean

    Used in GLTFObject3DExtrasExtension and iObjectCommons.upgradeObject3D

    Optional__needsSourceBuffer

    __needsSourceBuffer?: boolean

    This can be set to true in the importer to indicate that the source buffer should be loaded and cached in the userdata during processRaw

    Optional__sourceBlob

    __sourceBlob?: IFile

    Cached source blob for the asset

    Optional__sourceBuffer

    __sourceBuffer?: ArrayBuffer

    Cached source buffer for the asset (only cached when __needsSourceBuffer is set)

    Optional_originalMaterial

    _originalMaterial?:
        | IMaterial<IMaterialEventMap>
        | IMaterial<IMaterialEventMap>[]

    Optional_variantMaterials

    _variantMaterials?: Record<string, { material: IMaterial }>

    Starts with _ so that its not saved in gltf, but saved in json.

    animationObjects?: AnimationObject<any>[]
    autoCentered?: boolean
    autoRegisterInManager?: boolean

    Automatically register this object in the AssetManager when added to the scene. This provides hook to other plugins to extend the object, add uiconfig, etc.

    true
    autoScaled?: boolean
    autoScaleRadius?: number
    autoUpdateParent?: boolean

    Disables bubbleToParent in setDirty calls on the object. As an effect scene, viewer are not updated on property change. See progressive-hdr-shadows-exp or any baker.

    bboxVisible?: boolean

    should this object be taken into account when calculating bounding box, default true

    constraints?: ObjectConstraint<keyof ConstraintPropsTypes>[]
    dispose?: any
    disposeOnIdle?: boolean

    Auto dispose when removed from the scene. Note - this is only used when Object3DManager.autoDisposeObjects is true

    true
    excludeFromExport?: boolean

    When true, this object will not be exported when exporting the scene with AssetExporter.exportObject

    geometriesCentered?: boolean
    gltfAnim_SyncMaxDuration?: boolean

    see GLTFAnimationPlugin

    isCentered?: boolean
    license?: string
    physicsMass?: number

    For Physics plugins

    pseudoCentered?: boolean

    Is centered in a parent object.

    rootPath?: string

    The path from which the asset was downloaded/imported.

    rootPathOptions?: Record<string, any>

    Incase files are loaded as different extensions(like for json), this will be set.

    rootPathRefresh?: boolean

    Whether to refresh this object from the asset manager when its loaded as an embedded object

    rootSceneModelRoot?: boolean

    is it modelRoot in RootScene, used during serialization nad traversing ancestors

    setDirty?: any
    setGeometry?: any
    setMaterial?: any
    sProperties?: string[]

    List of properties that will be saved in the glb files when this object is saved. The other properties are expected to be loaded/filled at runtime by default values or from an external object loaded from IImportResultUserData.rootPath. Note - this is not implemented, added to userData for future.

    TransformAnimationPlugin?: { transforms: TSavedTransform[] }
    transformControls?: {
        lockProps?: string[];
        mode?: "translate" | "rotate" | "scale";
        rotationSnap?: number;
        scaleSnap?: number;
        showX?: boolean;
        showY?: boolean;
        showZ?: boolean;
        space?: "world" | "local";
        translationSnap?: number;
    }

    Settings for TransformControls2 when this object is selected. See TransformControlsPlugin

    userSelectable?: boolean

    When false, this object will not be selectable when clicking on it.

    uuid?: string

    Settings

    Member Visibility

    On This Page

    Properties