This functionality is provided as a preview
of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the
Fusion API and Scripts forum.
Because this is a preview of future functionality, there is the possibility that it will change, which will possibly
break any existing programs that use this functionality. Because of that, you should never deliver any programs that use
any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.
A storyboard consists of views and actions distributed along a timeline.
| Name | Description |
| activate |
Sets this storyboard to be active. |
| classType |
Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType(). |
| copy |
Method that copies the storyboard. |
| deleteMe |
Method that deletes the storyboard. |
| moveTo |
Method that moves the storyboard to another position. |
| play |
Method that plays the storyboard. |
| reverse |
Method that reverses the sequence of actions for the storyboard. |
| Name | Description |
| end | Gets the end time of the storyboard in seconds. |
| isActive | Returns true if this storyboard is the active storyboard. |
| isInFullScreenMode | Gets and sets whether it is in full screen mode for animation playback. |
| isInPlayMode | Returns true if it is in play mode. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| isViewRecordingOn | Gets and sets whether the view recording is on or off. When enabled, the view recording captures the camera change of the viewport and creates ViewAction accordingly. |
| objectType | This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object. It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType(): |
| parent | Gets the parent AnimationManager of this storyboard. |
| playheadPosition | Gets and sets the position of the playhead on the timeline in seconds. Sets to -1 will place the playhead to the scratch zone. |