RenderSchedule.ElementTimelineBuilder Class
As part of a RenderSchedule.ScriptBuilder, assembles a RenderSchedule.ElementTimeline.
@see RenderSchedule.ModelTimelineBuilder.addElementTimeline.
Extends
Methods
Name | Description | |
---|---|---|
constructor(batchId: number, elementIds: string): RenderSchedule.ElementTimelineBuilder | Constructor - typically not used directly. | |
finish(): RenderSchedule.ElementTimelineProps | Obtain the JSON representation of the RenderSchedule.ElementTimeline 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 | |
---|---|---|---|
batchId Readonly | number | A positive integer that uniquely identifies this timeline among all element timelines in the RenderSchedule.Script. | |
elementIds Readonly | string | The compressed set of Ids of the elements 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
- core/common/src/RenderSchedule.ts Line 1346
Last Updated: 16 April, 2024
Found something wrong, missing, or unclear on this page?
Raise an issue in our repo.