Class USDDocument

Hierarchy (View Summary)

USDObject
- USDDocument

Index

Constructors

Accessors

isDocumentRoot isDynamic matrix

Methods

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

Constructors

constructor

new USDDocument(): USDDocument
Returns USDDocument
Overrides USDObject.constructor

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

isDocumentRoot

get isDocumentRoot(): boolean
Returns boolean

isDynamic

get isDynamic(): boolean
Returns boolean
Overrides USDObject.isDynamic

matrix

get matrix(): Matrix4
Returns Matrix4
Deprecated
Use transform, or getMatrix() if you really need the matrix

Inherited from USDObject.matrix
set matrix(value: Matrix4): void
Parameters
- value: Matrix4
Returns void
Deprecated
Use transform, or setMatrix() if you really need the matrix

Inherited from USDObject.matrix

Methods

add

add(child: USDObject): void
Parameters
- child: USDObject
Returns void
Overrides USDObject.add

addEventListener

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

buildHeader

buildHeader(_context: USDZExporterContext): string
Parameters
- _context: USDZExporterContext
Returns string

clone

clone(): USDObject
Returns USDObject
Inherited from USDObject.clone

deepClone

deepClone(): USDObject
Returns USDObject
Inherited from USDObject.deepClone

findById

findById(uuid: string): undefined | USDObject
Parameters
- uuid: string
Returns undefined | USDObject

getMatrix

getMatrix(): Matrix4
Returns Matrix4
Inherited from USDObject.getMatrix

getPath

getPath(): string
Returns string
Inherited from USDObject.getPath

is

is(obj: any): boolean
Parameters
- obj: any
Returns boolean
Inherited from USDObject.is

isEmpty

isEmpty(): boolean
Returns boolean
Inherited from USDObject.isEmpty

onSerialize

onSerialize(writer: any, context: any): void
Parameters
- writer: any
- context: any
Returns void
Inherited from USDObject.onSerialize

remove

remove(child: USDObject): void
Parameters
- child: USDObject
Returns void
Overrides USDObject.remove

removeEventListener

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

setMatrix

setMatrix(value: any): void
Parameters
- value: any
Returns void
Inherited from USDObject.setMatrix

traverse

traverse(
callback: (object: USDObject) => void,
current?: null | USDObject,
): void
Parameters
- callback: (object: USDObject) => void
- current: null | USDObject = null
Returns void

`Static`createEmpty

createEmpty(): USDObject
Returns USDObject
Inherited from USDObject.createEmpty

`Static`createEmptyParent

createEmptyParent(object: USDObject): USDObject
Parameters
- object: USDObject
Returns USDObject
Inherited from USDObject.createEmptyParent