RenderSchedule.Script Class
Specifies how to animate the contents of a ViewState over time. The script contains any number of ModelTimelines, each describing how to animate one of the models in the view.
@see - RenderTimeline to create an Element to host a script.
- renderTimeline to associate a RenderTimeline's script with a DisplayStyle.
- DisplayStyleState.scheduleScript to obtain the script associated with a display style.
- ScriptBuilder to define a new script.
Methods
| Name | Description | |
|---|---|---|
| constructor(props: ReadonlyArray<RenderSchedule.ModelTimelineProps>): RenderSchedule.Script Protected | ||
| compareTo(other: RenderSchedule.Script): number | ||
| equals(other: RenderSchedule.Script): boolean | ||
| find(modelId: string): undefined | RenderSchedule.ModelTimeline | Look up the timeline that animates the specified model, if any. | |
| toJSON(): RenderSchedule.ScriptProps | ||
| fromJSON(props: ReadonlyArray<RenderSchedule.ModelTimelineProps>): undefined | RenderSchedule.Script Static |
Properties
| Name | Type | Description | |
|---|---|---|---|
| containsFeatureOverrides Readonly | boolean | True if this script affects the color or transparency of the geometry. | |
| containsModelClipping Readonly | boolean | True if this script applies clipping to any models. | |
| containsTransform Readonly | boolean | True if this script affects the position, orientation, or scale of the geometry. | |
| duration Readonly | Range1d | The total time period over which this script animates. | |
| modelTimelines Readonly | ReadonlyArray<RenderSchedule.ModelTimeline> | Timelines specifying how to animate individual models within the view. |
Defined in
- core/common/src/RenderSchedule.ts Line 1041
Last Updated: 16 January, 2025
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.