DynamicGraphicsProvider Class

A class for creating and managing a RenderGraphic for the purpose of interactive tool dynamics.

Methods

Name Description
constructor(iModel: IModelConnection, prefix: string): DynamicGraphicsProvider    
addGraphic(context: DynamicsContext, transform?: Transform): void    
cleanupGraphic(): void Call to dispose of RenderGraphic held by RenderGraphicOwner.  
createGraphic(categoryId: string, placement: PlacementProps, geometry: JsonGeometryStream | FlatBufferGeometryStream): Promise<boolean> Call to request a RenderGraphic for the supplied geometry and placement.  
createGraphicAndUpdateDynamics(ev: BeButtonEvent, categoryId: string, placement: PlacementProps, geometry: JsonGeometryStream | FlatBufferGeometryStream): void Call to request a RenderGraphic for the supplied geometry and trigger a dynamic update upon fulfillment.  

Properties

Name Type Description
chordTolerance number Chord tolerance to use to stroke the element's geometry in meters  
elementId undefined | string Optional element id generated graphics will be associated to  
graphic undefined | RenderGraphicOwner    
iModel Readonly IModelConnection    
modelId undefined | string Optional model id generated graphics will be associated to  
prefix Readonly string    

Defined in

Last Updated: 16 April, 2024