FrameworkAccuDraw Class
Subclass of AccuDraw
in @itwin/core-frontend
to be used to initialize IModelApp
.
This implementation will generate the required events for the AppUI provided UI to update correctly.
await IModelApp.startup({
accuDraw: new FrameworkAccuDraw()
});
Extends
Implements
Methods
Name | Description | |
---|---|---|
constructor(): FrameworkAccuDraw | ||
grabInputFocus(): void | Implement this method to set focus to the AccuDraw UI. | |
loadUserSettings(storage: UiStateStorage): Promise<void> | Function to load settings from settings storage | |
onCompassModeChange(): void | ||
onFieldLockChange(index: ItemField): void | ||
onFieldValueChange(index: ItemField): void | ||
onMotion(_ev: BeButtonEvent): void | Implemented by sub-classes to update ui fields to show current deltas or coordinates when inactive. | |
onRotationModeChange(): void | ||
setFocusItem(index: ItemField): void | ||
getFieldDisplayValue(index: ItemField): string Static | Gets the display value for an AccuDraw field | |
setFieldValueFromUi(field: ItemField, stringValue: string): void Static | AccuDraw Set Field Value from Ui. |
Properties
Name | Type | Description | |
---|---|---|---|
displayNotifications Accessor Static | boolean | Determines if notifications should be displayed for AccuDraw changes | |
hasInputFocus Accessor ReadOnly | boolean | Determine if the AccuDraw UI has focus. | |
isACSRotationConditional Static Readonly | ConditionalBooleanValue | Determines if AccuDraw.rotationMode === RotationMode.ACS | |
isContextRotationConditional Static Readonly | ConditionalBooleanValue | Determines if AccuDraw.rotationMode === RotationMode.Context | |
isFrontRotationConditional Static Readonly | ConditionalBooleanValue | Determines if AccuDraw.rotationMode === RotationMode.Front | |
isPolarModeConditional Static Readonly | ConditionalBooleanValue | Determines if AccuDraw.compassMode === CompassMode.Polar | |
isRectangularModeConditional Static Readonly | ConditionalBooleanValue | Determines if AccuDraw.compassMode === CompassMode.Rectangular | |
isSideRotationConditional Static Readonly | ConditionalBooleanValue | Determines if AccuDraw.rotationMode === RotationMode.Side | |
isTopRotationConditional Static Readonly | ConditionalBooleanValue | Determines if AccuDraw.rotationMode === RotationMode.Top | |
isViewRotationConditional Static Readonly | ConditionalBooleanValue | Determines if AccuDraw.rotationMode === RotationMode.View | |
onAccuDrawGrabInputFocusEvent Static Readonly | AccuDrawGrabInputFocusEvent | AccuDraw Grab Input Focus event. | |
onAccuDrawSetCompassModeEvent Static Readonly | AccuDrawSetCompassModeEvent | AccuDraw Set Mode event. | |
onAccuDrawSetFieldFocusEvent Static Readonly | AccuDrawSetFieldFocusEvent | AccuDraw Set Field Focus event. | |
onAccuDrawSetFieldLockEvent Static Readonly | AccuDrawSetFieldLockEvent | AccuDraw Set Field Lock event. | |
onAccuDrawSetFieldValueFromUiEvent Static Readonly | AccuDrawSetFieldValueFromUiEvent | AccuDraw Set Field Value from Ui event. | |
onAccuDrawSetFieldValueToUiEvent Static Readonly | AccuDrawSetFieldValueToUiEvent | AccuDraw Set Field Value to Ui event. | |
onAccuDrawUiSettingsChangedEvent Static Readonly | AccuDrawUiSettingsChangedEvent | AccuDraw Grab Input Focus event. | |
providerId Readonly | "FrameworkAccuDraw" | Unique provider Id | |
uiStateStorage Accessor Static | undefined | AccuDrawUiSettings | AccuDraw User Interface settings |
Defined in
Last Updated: 17 December, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.