API Reference > core-common > DisplayStyles > RenderSchedule > RenderSchedule.ModelTimelineBuilder

RenderSchedule.ModelTimelineBuilder Class

As part of a [[RenderSchedule.ScriptBuilder, assembles a RenderSchedule.ModelTimeline.

see RenderSchedule.ScriptBuilder.addModelTimeline.

Extends

Methods

Name Description
constructor(modelId: string, obtainNextBatchId: () => number): RenderSchedule.ModelTimelineBuilder Constructor - typically not used directly.  
addElementTimeline(elementIds: string | Iterable<string>): RenderSchedule.ElementTimelineBuilder Add a new RenderSchedule.ElementTimeline to be applied to the specified elements.  
finish(): RenderSchedule.ModelTimelineProps Obtain the JSON representation of the RenderSchedule.ModelTimeline produced by this builder.  

Inherited methods

Name Inherited from Description
addColor(time: number, color: undefined | RgbColor | { blue: number, green: number, red: number }, interpolation: RenderSchedule.Interpolation = Interpolation.Linear): void RenderSchedule.TimelineBuilder Append a new RenderSchedule.ColorEntry to the timeline.
addCuttingPlane(time: number, plane: undefined | { direction: Readonly<WritableXYAndZ>, hidden?: boolean, position: Readonly<WritableXYAndZ>, visible?: boolean }, interpolation: RenderSchedule.Interpolation = Interpolation.Linear): void RenderSchedule.TimelineBuilder Append a new RenderSchedule.CuttingPlaneEntry to the timeline.
addTransform(time: number, transform: undefined | Readonly<Transform>, components?: { orientation: Point4d, pivot: Readonly<WritableXYAndZ>, position: Readonly<WritableXYAndZ> }, interpolation: RenderSchedule.Interpolation = Interpolation.Linear): void RenderSchedule.TimelineBuilder Append a new RenderSchedule.TransformEntry to the timeline.
addVisibility(time: number, visibility: undefined | number, interpolation: RenderSchedule.Interpolation = Interpolation.Linear): void RenderSchedule.TimelineBuilder Append a new RenderSchedule.VisibilityEntry to the timeline.

Properties

Name Type Description
modelId Readonly string The Id of the model affected by this timeline.  

Inherited properties

Name Type Inherited from Description
color undefined | RenderSchedule.ColorEntryProps[] RenderSchedule.TimelineBuilder Timeline controlling color.
cuttingPlane undefined | RenderSchedule.CuttingPlaneEntryProps[] RenderSchedule.TimelineBuilder Timeline controlling clipping.
transform undefined | RenderSchedule.TransformEntryProps[] RenderSchedule.TimelineBuilder Timeline controlling position and orientation.
visibility undefined | RenderSchedule.VisibilityEntryProps[] RenderSchedule.TimelineBuilder Timeline controlling visibility.

Defined in

Last Updated: 20 June, 2023