Class AnimationExtension

Implements

IUSDExporterExtension

Index

Constructors

Properties

injectImplicitBehaviours injectRestPoses

Accessors

animatedRoots animationData extensionName holdClipMap registeredClips

Methods

getClipCount getEndTimeCode getStartTimeByClip getStartTimeCode onAfterBuildDocument onAfterHierarchy onExportObject registerAnimation

Constructors

constructor

new AnimationExtension(quickLookCompatible: boolean): 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

animatedRoots

get animatedRoots(): MapIterator<Object3D<Object3DEventMap>>
Returns MapIterator<Object3D<Object3DEventMap>>

animationData

get animationData(): Map<Object3D<Object3DEventMap>, TransformData[]>
Returns Map<Object3D<Object3DEventMap>, TransformData[]>

extensionName

get extensionName(): string
The name of the extension

Returns string
Implementation of IUSDExporterExtension.extensionName

holdClipMap

get holdClipMap(): Map<AnimationClip, AnimationClip>
Returns Map<AnimationClip, AnimationClip>

registeredClips

get registeredClips(): MapIterator<AnimationClip>
Returns MapIterator<AnimationClip>

Methods

getClipCount

getClipCount(root: Object3D): number
Parameters
- root: Object3D
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

getStartTimeByClip

getStartTimeByClip(clip: null | AnimationClip): number
Parameters
- clip: null | AnimationClip
Returns number

getStartTimeCode

getStartTimeCode(): number
Returns number

onAfterBuildDocument

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

onAfterHierarchy

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

onExportObject

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

registerAnimation

registerAnimation(
root: Object3D,
clip: null | AnimationClip,
): null | RegisteredAnimationInfo
Register an AnimationClip for a specific root object.
Parameters
- root: Object3D
  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.