API Reference › core-frontend › LocatingElements › HitDetailProps

HitDetailProps Interface

Arguments supplied to the HitDetail constructor.

Properties

Name Type Description
distFraction Readonly number The distance in view coordinates between the hit and the near plane.  
distXY Readonly number The xy distance to the hit in view coordinates.  
geometryClass Readonly undefined | GeometryClass The class of the hit geometry.  
hitPoint Readonly Point3d The approximate location in world coordinates on the geometry identified by this HitDetail.  
hitSource Readonly HitSource The procedure that requested the locate operation.  
modelId Readonly undefined | string The Id of the ModelState from which the hit originated.  
priority Readonly HitPriority The hit geometry priority/classification.  
sourceId Readonly string The source of the geometry.  
subCategoryId Readonly undefined | string The SubCategory to which the hit geometry belongs.  
testPoint Readonly Point3d The point in world coordinates that was used as the initial locate point.  
viewAttachment Readonly undefined | ViewAttachmentHitInfo Information about the ViewAttachment within which the hit geometry resides, if any.  
viewport Readonly ScreenViewport The viewport in which the locate operation was performed.  

Defined in

Last Updated: 25 April, 2024