Class AnimationExtension

Implements

IUSDExporterExtension

Index

Constructors

Properties

injectImplicitBehaviours injectRestPoses

Accessors

Methods

getClipCount getEndTimeCode getStartTime01 getStartTimeCode onAfterBuildDocument onAfterHierarchy onExportObject registerAnimation

Constructors

constructor

new AnimationExtension(quickLookCompatible): AnimationExtension
Parameters
- quickLookCompatible: boolean
Returns AnimationExtension

Properties

injectImplicitBehaviours

injectImplicitBehaviours: boolean = false

Determines if we inject a PlayAnimationOnClick component with "scenestart" trigger - only makes sense for QuickLook

injectRestPoses

injectRestPoses: boolean = false

Determines if we inject a rest pose clip for each root - only makes sense for QuickLook

Accessors

extensionName

get extensionName(): string
The name of the extension

Returns string
Implementation of IUSDExporterExtension.extensionName

Methods

getClipCount

getClipCount(root): number
Parameters
- root: Object3D<Object3DEventMap>
Returns number

getEndTimeCode

getEndTimeCode(): number
Returns the end time code, based on 60 frames per second, for all registered animations. This matches the highest time value in the USDZ file.

Returns number

getStartTime01

getStartTime01(root, clip): number
Parameters
- root: Object3D<Object3DEventMap>
- clip: null | AnimationClip
Returns number

getStartTimeCode

getStartTimeCode(): number
Returns number

onAfterBuildDocument

onAfterBuildDocument(_context): void
Called after the document is built
Parameters
- _context: any
Returns void
Implementation of IUSDExporterExtension.onAfterBuildDocument

onAfterHierarchy

onAfterHierarchy(_context): void
Parameters
- _context: any
Returns void
Implementation of IUSDExporterExtension.onAfterHierarchy

onExportObject

onExportObject(object, model, _context): void
Parameters
- object: any
- model: USDObject
- _context: any
Returns void
Implementation of IUSDExporterExtension.onExportObject

registerAnimation

registerAnimation(root, clip): null | RegisteredAnimationInfo
Register an AnimationClip for a specific root object.
Parameters
- root: Object3D<Object3DEventMap>
  The root object that the animation clip is targeting.
- clip: null | AnimationClip
  The animation clip to register. If null, a rest pose is registered.
Returns null | RegisteredAnimationInfo
The registered animation info, which contains the start time and duration of the clip.