Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HitItem

Interface for an object describing the result of a picking action on a RemoteModel.

This object is provided to the RayIntersectCallback.

Hierarchy

  • HitItem

Index

Properties

anythingHit

anythingHit: boolean

Whether anything was hit during the action. If false, the other properties in this object will be undefined.

elementId

elementId: number

The id of the element in the data model on the server that was hit

elementIndex

elementIndex: number

The index of the element in the data model on the server that was hit

elementNodeResult

elementNodeResult: number

The scalar result in the closest element node. Only defined if the current result is per element node

elementResult

elementResult: number

The scalar result in the element that was hit.

elementResultIsInterpolated

elementResultIsInterpolated: boolean

Whether the element result is interpolated (e.g. from a nodal result). False if the result is an actual per element result.

elementTriangleVertices

elementTriangleVertices: number[]

A tessellation of triangles of the element that was hit.

This array contains x,y,z values for each triangle vertex. So there will be 9 values (3 vertices * (x,y,z)) per triangle. This can be used to highlight the selected element using the geometry or the markup model.

elementType

elementType: string

The type of the element in the data model on the server that was hit, for example 'Quad', 'Tetrahedron', 'Hexahedron'

elementVolume

elementVolume: number

The volume of the element (if applicable)

frameIndex

frameIndex: number

The index of the frame in which the picking occurred. This is 0 unless there is an animation.

geometryIndex

geometryIndex: number

The index of the CAE geometry.

In almost all cases this will be 0. If using a partially adaptive model with remeshing only on parts of the model (e.g. in a Forging process) the concept of multiple geometries might be relevant.

intersectionPoint

intersectionPoint: Vec3

The 3d point (in world coordinates) on the surface that was hit.

This is the actual point that was hit

intersectionPointNormal

intersectionPointNormal: Vec3

The normal of the surface at the point where the surface was hit.

intersectionPointResult

intersectionPointResult: number

The interpolated scalar result in the intersectionPoint.

nodeId

nodeId: number

The id of the node in the data model on the server that was hit

nodeIndex

nodeIndex: number

The index of the node in the data model on the server that was hit

nodeResult

nodeResult: number

The scalar result in the closest node as indicated by nodeId/nodeIndex.

nodeResultIsInterpolated

nodeResultIsInterpolated: boolean

Whether the node result is interpolated (e.g. from a per element result). False if the result is an actual per node result.

objectId

objectId: number

The id of the object (part/iso/cut/isovol) that was hit

objectIndex

objectIndex: number

The index of the object (part/iso/cut/isovol) that was hit

objectName

objectName: string

The name of the object (part/iso/cut/isovol) that was hit

objectType

objectType: ObjectType

The type of object (part/iso/cut/isovol) that was hit

scalarResultName

scalarResultName: string

The name of the scalar that the results elementResult and nodeResult apply to.

Generated using TypeDoc