API Reference › editor-frontend › Editing › ProjectExtentsClipDecoration

ProjectExtentsClipDecoration Class

Controls to modify project extents shown using view clip

Extends

  • HandleProvider

Methods

Name Description
constructor(viewport: ScreenViewport): ProjectExtentsClipDecoration    
clearControls(): void Protected    
createControls(): Promise<boolean> Protected    
decorate(context: DecorateContext): void    
drawAreaTooLargeIndicator(context: DecorateContext): void Protected    
drawExtentTooLargeIndicator(context: DecorateContext, worldPoint: Point3d, sizePixels: number): void Protected    
drawMonumentPoint(context: DecorateContext, point: Point3d, scaleFactor: number, id?: string): void    
drawNorthArrow(context: DecorateContext, northDir: Ray3d, id?: string): void    
fitExtents(): void    
getClockwiseAngleToNorth(): Angle    
getDecorationToolTip(hit: HitDetail): Promise<string | HTMLElement>    
getModifiedEcefLocation(): undefined | EcefLocation    
getModifiedExtents(): undefined | Range3d    
getMonumentPoint(): Point3d    
getNorthAngle(): Angle    
getNorthDirection(refOrigin?: Point3d): Ray3d    
hasValidGCS(): boolean Protected    
init(): boolean Protected    
modifyControls(hit: HitDetail, _ev: BeButtonEvent): Promise<boolean> Protected    
onDecorationButtonEvent(hit: HitDetail, ev: BeButtonEvent): Promise<EventHandled>    
onManipulatorEvent(eventType: EventType): void    
onRightClick(_hit: HitDetail, _ev: BeButtonEvent): Promise<EventHandled> Protected    
onTouchTap(hit: HitDetail, ev: BeButtonEvent): Promise<EventHandled> Protected    
onViewClose(vp: ScreenViewport): void    
resetGeolocation(): boolean    
resetViewClip(): boolean    
start(): void Protected    
stop(): void Protected    
testDecorationHit(id: string): boolean    
updateDecorationListener(_add: boolean): void Protected    
updateEcefLocation(origin: Cartographic, point?: Point3d, angle?: Angle): boolean    
updateNorthDirection(northDir: Ray3d): boolean    
allowEcefLocationChange(requireExisting: boolean, outputError: boolean = true): boolean Static    
clear(clearClip: boolean = true, resetGeolocation: boolean = true): void Static    
get(): undefined | ProjectExtentsClipDecoration Static    
hide(): void Static    
show(vp: ScreenViewport, fitExtents: boolean = true): boolean Static    
update(): Promise<void> Static    

Inherited methods

Name Inherited from Description
onDoubleClick(_hit: HitDetail, _ev: BeButtonEvent): Promise<EventHandled> Protected EditManipulator.HandleProvider Sub-classes can override to perform some operation for a double click on a handle.
onManipulatorToolEvent(_tool: Tool, event: ManipulatorToolEvent): void EditManipulator.HandleProvider Event raised by a PrimitiveTool that supports handle providers.
onSelectionChanged(ev: SelectionSetEvent): void EditManipulator.HandleProvider Event raised by SelectionSet when the active selection changes.
updateControls(): Promise<void> Protected EditManipulator.HandleProvider  

Properties

Name Type Description
_allowEcefLocationChange Protected boolean    
_clip Protected undefined | ClipVector    
_clipId Protected undefined | string    
_clipRange Protected undefined | Range3d    
_clipShape Protected undefined | ClipShape    
_clipShapeExtents Protected undefined | Range1d    
_controlIds Protected string[]    
_controls Protected ProjectExtentsControlArrow[]    
_ecefLocation Protected undefined | EcefLocation    
_extentsHeightValid Protected boolean    
_extentsLengthValid Protected boolean    
_extentsWidthValid Protected boolean    
_monumentId Protected undefined | string    
_monumentPoint Protected undefined | Point3d    
_northDirection Protected undefined | Ray3d    
_northId Protected undefined | string    
_removeViewCloseListener Protected undefined | () => void    
_suspendDecorator Protected boolean    
maxExtentHeight Accessor ProtectedReadOnly number Impose some reasonable height limit for project extents.  
maxExtentLength Accessor ProtectedReadOnly number Allow project extents for map projections to be larger since curvature of the earth is accounted for.  
onChanged Readonly BeEvent<(iModel: IModelConnection, ev: ProjectLocationChanged) => void> Called when project extents or geolocation is modified  
suspendGeolocationDecorations boolean    
viewport ScreenViewport    

Inherited properties

Name Type Inherited from Description
_isActive Protected boolean EditManipulator.HandleProvider  
_removeDecorationListener Protected undefined | () => void EditManipulator.HandleProvider  
_removeManipulatorToolListener Protected undefined | () => void EditManipulator.HandleProvider  
_removeSelectionListener Protected undefined | () => void EditManipulator.HandleProvider  
iModel IModelConnection EditManipulator.HandleProvider  

Defined in

Last Updated: 16 April, 2024