HitDetail Class
A HitDetail stores the result when locating geometry displayed in a view. It holds an approximate location on an element (or decoration) from a pick.
extensions
Extended by
Methods
| Name | Description | |
|---|---|---|
| constructor(testPoint: Point3d, viewport: ScreenViewport, hitSource: HitSource, hitPoint: Point3d, sourceId: string, priority: HitPriority, distXY: number, distFraction: number, subCategoryId?: string, geometryClass?: GeometryClass, modelId?: string, iModel?: IModelConnection, tileId?: string, isClassifier?: boolean): HitDetail | Create a new HitDetail from the inputs to and results of a locate operation. | |
| clone(): HitDetail | Create a deep copy of this HitDetail | |
| draw(_context: DecorateContext): void | Draw this HitDetail as a Decoration. | |
| getHitType(): HitDetailType | Get the type of HitDetail. | |
| getPoint(): Point3d | Get the hit point for this HitDetail. | |
| getToolTip(): Promise<string | HTMLElement> | Get the tooltip content for this HitDetail. | |
| isSameHit(otherHit?: HitDetail): boolean | Determine if this HitPoint is from the same source as another HitDetail. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| distFraction Readonly | number | ||
| distXY Readonly | number | ||
| geometryClass Readonly | undefined | GeometryClass | ||
| hitPoint Readonly | Point3d | ||
| hitSource Readonly | HitSource | ||
| iModel Accessor ReadOnly | IModelConnection | The IModelConnection from which the hit originated. | |
| isElementHit Accessor ReadOnly | boolean | Return whether sourceId is for a persistent element and not a pickable decoration. | |
| isExternalIModelHit Accessor ReadOnly | boolean | Returns true if this hit originated from an IModelConnection other than the one associated with the Viewport. | |
| isMapHit Accessor ReadOnly | boolean | ||
| isModelHit Accessor ReadOnly | boolean | ||
| modelId Readonly | undefined | string | ||
| priority Readonly | HitPriority | ||
| sourceId Readonly | string | ||
| subCategoryId Readonly | undefined | string | ||
| testPoint Readonly | Point3d | ||
| viewport Readonly | ScreenViewport |
Defined in
- core/frontend/src/HitDetail.ts Line 114
Last Updated: 30 November, 2023