Class DimensionLineManager

Manager for dimension lines, which can be used to display certain dimensions like object sizes in the scene

Hierarchy

DimensionLineManager

Index

Properties

DIMENSION_LINE_KEY

Methods

addDimensionLine removeAllDimensionLines removeDimensionLine setDefaultDimensionLineOptions

Properties

`Static` `Readonly` DIMENSION_LINE_KEY

DIMENSION_LINE_KEY: "$dimLine" = '$dimLine'

Methods

addDimensionLine

addDimensionLine(name: string, startPoint: Vector3, endPoint: Vector3, options?: Partial<DimensionLineOptions>): void
Create dimension line between two points.
Already existing dimension line gets updated in place, which is useful for dynamic operations like dragging.
Parameters
- name: string
- startPoint: Vector3
- endPoint: Vector3
- Optional options: Partial<DimensionLineOptions>
Returns void
- Defined in manager/dimension-line-manager.ts:98

removeAllDimensionLines

removeAllDimensionLines(groups?: string[]): void
Remove all dimension lines that have been created with the DimensionLineManager
Parameters
- Optional groups: string[]
  
  if set, only dimension lines which are part of these groups will be removed
  if left undefined, ALL dimension lines will be removed
Returns void
- Defined in manager/dimension-line-manager.ts:208

removeDimensionLine

removeDimensionLine(name: string): void
Remove dimension line and disposes all associated ressources
Parameters
- name: string
Returns void
- Defined in manager/dimension-line-manager.ts:189

setDefaultDimensionLineOptions

setDefaultDimensionLineOptions(defaultLineOptions: Partial<DimensionLineOptions>): void
Define dimension line options that are used for each line by default.
Options can be overwritten by each line individually.
Parameters
- defaultLineOptions: Partial<DimensionLineOptions>
Returns void
- Defined in manager/dimension-line-manager.ts:90

Generated using TypeDoc