API Reference > imodeljs-common > DisplayStyles > RenderSchedule > RenderSchedule.Timeline

RenderSchedule.Timeline Class

Specifies how to animate a set of geometry over time within a RenderSchedule.Script. A RenderSchedule.Script can contain any number of RenderSchedule.Timelines, each affecting different sets of geometry.

see RenderSchedule.ElementTimeline and RenderSchedule.ModelTimeline.

Extended by

Methods

Name Description
constructor(props: RenderSchedule.TimelineProps): RenderSchedule.Timeline    
getAnimationTransform(time: number): Readonly<Transform> Get the transform applied to the geometry at the specified time point.  
getClipVector(time: number): undefined | ClipVector Create a ClipVector from the RenderSchedule.CuttingPlane applied to the geometry at the specified time point, if any.  
getColor(time: number): undefined | RgbColor Get the color of the geometry at the specified time point, or undefined if the color is not overridden at that time point.  
getCuttingPlane(time: number): undefined | Plane3dByOriginAndUnitNormal Get the clipping plane applied to the geometry at the specified time point, or undefined if the geometry is unclipped at that time point.  
getVisibility(time: number): number Get the visibility of the geometry at the specified time point.  
toJSON(): RenderSchedule.TimelineProps    

Properties

Name Type Description
color Readonly undefined | RenderSchedule.TimelineEntryList<RenderSchedule.ColorEntry, RenderSchedule.ColorEntryProps, undefined | RgbColor> Sequence controlling the color of the geometry.  
cuttingPlane Readonly undefined | RenderSchedule.TimelineEntryList<RenderSchedule.CuttingPlaneEntry, RenderSchedule.CuttingPlaneEntryProps, undefined | RenderSchedule.CuttingPlane> Sequence controlling how the geometry is clipped.  
duration Readonly Range1d The total time period represented by this timeline.  
transform Readonly undefined | RenderSchedule.TransformTimelineEntries Sequence controlling the position, orientation, and/or scale of the geometry.  
visibility Readonly undefined | RenderSchedule.VisibilityTimelineEntries Sequence controlling the visibility of the geometry.  

Defined in

Last Updated: 12 June, 2024