Interface IObject3DUserData

interface IObject3DUserData {
    __autoBubbleToParentEvents?: string[];
    __gltfAsset?: {};
    __gltfExtras?: any;
    __importData?: any;
    __keepShadowDef?: boolean;
    __meshSetup?: boolean;
    __needsSourceBuffer?: boolean;
    __objectSetup?: boolean;
    __sourceBlob?: IFile;
    __sourceBuffer?: ArrayBuffer;
    _originalMaterial?: IMaterial | IMaterial[];
    _variantMaterials?: Record<string, { material: IMaterial }>;
    autoCentered?: boolean;
    autoScaled?: boolean;
    autoScaleRadius?: number;
    bboxVisible?: boolean;
    dispose?: any;
    excludeFromExport?: boolean;
    geometriesCentered?: boolean;
    gltfAnim_SyncMaxDuration?: boolean;
    isCentered?: boolean;
    license?: string;
    physicsMass?: number;
    pseudoCentered?: boolean;
    rootPath?: string;
    rootSceneModelRoot?: boolean;
    setDirty?: any;
    setGeometry?: any;
    setMaterial?: any;
    TransformAnimationPlugin?: { transforms: TSavedTransform[] };
    userSelectable?: boolean;
    uuid?: string;
    [key: string]: any;
}

Hierarchy (View Summary)

Indexable

  • [key: string]: any

Properties

__autoBubbleToParentEvents? __gltfAsset? __gltfExtras? __importData? __keepShadowDef? __meshSetup? __needsSourceBuffer? __objectSetup? __sourceBlob? __sourceBuffer? _originalMaterial? _variantMaterials? autoCentered? autoScaled? autoScaleRadius? bboxVisible? dispose? excludeFromExport? geometriesCentered? gltfAnim_SyncMaxDuration? isCentered? license? physicsMass? pseudoCentered? rootPath? rootSceneModelRoot? setDirty? setGeometry? setMaterial? TransformAnimationPlugin? 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?: 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__meshSetup

__meshSetup?: boolean

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__objectSetup

__objectSetup?: boolean

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 | IMaterial[]

Optional_variantMaterials

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

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

OptionalautoCentered

autoCentered?: boolean

OptionalautoScaled

autoScaled?: boolean

OptionalautoScaleRadius

autoScaleRadius?: number

OptionalbboxVisible

bboxVisible?: boolean

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

Optionaldispose

dispose?: any

Deprecated

OptionalexcludeFromExport

excludeFromExport?: boolean

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

OptionalgeometriesCentered

geometriesCentered?: boolean

OptionalgltfAnim_SyncMaxDuration

gltfAnim_SyncMaxDuration?: boolean

see GLTFAnimationPlugin

OptionalisCentered

isCentered?: boolean

Optionallicense

license?: string

OptionalphysicsMass

physicsMass?: number

For Physics plugins

OptionalpseudoCentered

pseudoCentered?: boolean

Is centered in a parent object.

OptionalrootPath

rootPath?: string

OptionalrootSceneModelRoot

rootSceneModelRoot?: boolean

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

OptionalsetDirty

setDirty?: any

Deprecated

OptionalsetGeometry

setGeometry?: any

Deprecated

OptionalsetMaterial

setMaterial?: any

Deprecated

OptionalTransformAnimationPlugin

TransformAnimationPlugin?: { transforms: TSavedTransform[] }

OptionaluserSelectable

userSelectable?: boolean

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

Optionaluuid

uuid?: string

Settings

Member Visibility

On This Page

Properties