Class BimCTClippingRegions

Class managing clipping regions.

Hierarchy

BimCTClippingRegions

Constructors

constructor

new BimCTClippingRegions(owner: BaseBimCanvas): BimCTClippingRegions
Parameters
- owner: BaseBimCanvas
Returns BimCTClippingRegions
- Defined in overlay/clipping.ts:57

Accessors

highlightedRegion

get highlightedRegion(): ClippingRegion
Gets the highlighted region

Returns ClippingRegion
- Defined in overlay/clipping.ts:625

Methods

addRegion

addRegion(rectangle: Rectangle): Promise<ClippingRegion>
Add a new clipping region.

Returns
null if the rectangle overlaps with another region or the newly added region
Parameters
- rectangle: Rectangle
Returns Promise<ClippingRegion>
- Defined in overlay/clipping.ts:99

bringToFront

bringToFront(region: ClippingRegion): void
Brings the specified region to the front by drawing it last.
Parameters
- region: ClippingRegion
  
  The region to bring to the front.
Returns void
- Defined in overlay/clipping.ts:639

clearRegions

clearRegions(): Promise<void>
Clear all regions.

Returns Promise<void>
- Defined in overlay/clipping.ts:177

containsMeasurement

containsMeasurement(region: ClippingRegion, measurement: Measurement): Promise<boolean>
Checks if a Measurement is contained within a region
Parameters
- region: ClippingRegion
- measurement: Measurement
Returns Promise<boolean>
- Defined in overlay/clipping.ts:564

destroy

destroy(): void
Destroys the clipping region manager by clearing all regions, removing the canvas from the DOM, and releasing resources.

Returns void
- Defined in overlay/clipping.ts:573

getAllRegions

getAllRegions(): ClippingRegion[]
Get all regions.

Returns ClippingRegion[]
- Defined in overlay/clipping.ts:160

getByIndex

getByIndex(index: number): ClippingRegion
Get a region by its index in the _regions array.
Parameters
- index: number
Returns ClippingRegion
- Defined in overlay/clipping.ts:167

getClippingRegion

getClippingRegion(x: number, y: number): ClippingRegion
Get the clipping region that is behind a point

Returns
The BimCTClippingRegion containing the point, or null if no region contains the point.
Parameters
- x: number
  
  The x-coordinate of the point.
- y: number
  
  The y-coordinate of the point.
Returns ClippingRegion
- Defined in overlay/clipping.ts:702

getClippingRegionOfLine

getClippingRegionOfLine(x: number, y: number, x1: number, y1: number): ClippingRegion
Parameters
- x: number
- y: number
- x1: number
- y1: number
Returns ClippingRegion
- Defined in overlay/clipping.ts:718

getClippingRegionOfMeasurement

getClippingRegionOfMeasurement(m: Measurement): Promise<ClippingRegion>
Gets the clipping region of a measurement.

Returns
The clipping region or null if not found.
Parameters
- m: Measurement
  
  The measurement.
Returns Promise<ClippingRegion>
- Defined in overlay/clipping.ts:658

getState

getState(): RegionsClippingState
Gets the current state of the clipping regions.

Returns
The current state of the clipping regions.

Returns RegionsClippingState
- Defined in overlay/clipping.ts:765

highlightRegion

highlightRegion(x: number, y: number): void
Highlights the region and brings it forward
Parameters
- x: number
  
  The x-coordinate of the point.
- y: number
  
  The y-coordinate of the point.
Returns void
- Defined in overlay/clipping.ts:600

isInsideActiveBounds

isInsideActiveBounds(x: number, y: number): boolean
Check if a point is inside any clipping region.

Returns
true if no region exist or if this point lies inside a region otherwise false
Parameters
- x: number
  
  The x-coordinate of the point.
- y: number
  
  The y-coordinate of the point.
Returns boolean
- Defined in overlay/clipping.ts:680

redraw

redraw(): Promise<void>
Redraws the clipping regions.

Returns Promise<void>
- Defined in overlay/clipping.ts:492

removeByIndex

removeByIndex(index: number): Promise<void>
Remove a region by its index in the _regions array.
Parameters
- index: number
Returns Promise<void>
- Defined in overlay/clipping.ts:147

removeRegion

removeRegion(region: ClippingRegion): Promise<boolean>
Remove a region by its BimCTClippingRegion reference.
Parameters
- region: ClippingRegion
Returns Promise<boolean>
- Defined in overlay/clipping.ts:130

resize

resize(width: number, height: number): Promise<void>
Resizes the canvas to the specified dimensions and redraws all clipping regions.
Parameters
- width: number
  
  The new width of the canvas in pixels.
- height: number
  
  The new height of the canvas in pixels.
Returns Promise<void>
- Defined in overlay/clipping.ts:587

setState

setState(state: RegionsClippingState): void
Sets the state of the clipping regions.
Parameters
- state: RegionsClippingState
  
  The state to set.
Returns void
- Defined in overlay/clipping.ts:741