Class USDObject

Hierarchy (View Summary)

USDObject
- USDDocument

Index

Constructors

Properties

extraSchemas type?

Accessors

isDynamic matrix

Methods

add addEventListener clone deepClone getMatrix getPath is isEmpty onSerialize remove removeEventListener setMatrix createEmpty createEmptyParent

Constructors

constructor

new USDObject(
    id: any,
    name: any,
    transform?: null | USDObjectTransform,
    mesh?: null | BufferGeometry<NormalBufferAttributes>,
    material?: null | Material | MeshBasicMaterial | MeshStandardMaterial,
    camera?: null | PerspectiveCamera | OrthographicCamera,
    skinnedMesh?:
        | null
        | SkinnedMesh<
            BufferGeometry<NormalBufferAttributes>,
            Material | Material[],
            Object3DEventMap,
        >,
    animations?: null | AnimationClip[],
): USDObject
Parameters
- id: any
- name: any
- transform: null | USDObjectTransform = null
- mesh: null | BufferGeometry<NormalBufferAttributes> = null
- material: null | Material | MeshBasicMaterial | MeshStandardMaterial = null
- camera: null | PerspectiveCamera | OrthographicCamera = null
- skinnedMesh:
      | null
      | SkinnedMesh<
          BufferGeometry<NormalBufferAttributes>,
          Material | Material[],
          Object3DEventMap,
      > = null
- animations: null | AnimationClip[] = null
Returns USDObject

Properties

extraSchemas

extraSchemas: string[] = []

MaterialBindingAPI and SkelBindingAPI are handled automatically, extra schemas can be added here

`Optional`type

type?: string

If no type is provided, type is chosen automatically (Xform or Mesh)

Accessors

isDynamic

get isDynamic(): boolean
Returns boolean
set isDynamic(value: boolean): void
Parameters
- value: boolean
Returns void

matrix

get matrix(): Matrix4
Returns Matrix4
Deprecated
Use transform, or getMatrix() if you really need the matrix
set matrix(value: Matrix4): void
Parameters
- value: Matrix4
Returns void
Deprecated
Use transform, or setMatrix() if you really need the matrix

Methods

add

add(child: any): void
Parameters
- child: any
Returns void

addEventListener

addEventListener(
evt: any,
listener: (writer: USDWriter, context: USDZExporterContext) => void,
): void
Parameters
- evt: any
- listener: (writer: USDWriter, context: USDZExporterContext) => void
Returns void

clone

clone(): USDObject
Returns USDObject

deepClone

deepClone(): USDObject
Returns USDObject

getMatrix

getMatrix(): Matrix4
Returns Matrix4

getPath

getPath(): string
Returns string

is

is(obj: any): boolean
Parameters
- obj: any
Returns boolean

isEmpty

isEmpty(): boolean
Returns boolean

onSerialize

onSerialize(writer: any, context: any): void
Parameters
- writer: any
- context: any
Returns void

remove

remove(child: any): void
Parameters
- child: any
Returns void

removeEventListener

removeEventListener(
evt: any,
listener: (writer: USDWriter, context: USDZExporterContext) => void,
): void
Parameters
- evt: any
- listener: (writer: USDWriter, context: USDZExporterContext) => void
Returns void

setMatrix

setMatrix(value: any): void
Parameters
- value: any
Returns void

`Static`createEmpty

createEmpty(): USDObject
Returns USDObject

`Static`createEmptyParent

createEmptyParent(object: USDObject): USDObject
Parameters
- object: USDObject
Returns USDObject