HitItem
-
class
cee.ug.HitItem() Interface for an object describing the result of a picking action on a
RemoteModel.This object is provided to the
RayIntersectCallback.Index
Properties
anythingHitelementAreaelementEdgeIndexelementFaceIndexelementIdelementIndexelementNodeIndexelementNodeResultelementResultelementResultIsInterpolatedelementTriangleVerticeselementTypeelementVolumeframeIndexgeometryIndexintersectionPointintersectionPointNormalintersectionPointResultnodeIdnodeIndexnodePositionnodeResultnodeResultIsInterpolatedobjectIdobjectIndexobjectNameobjectTypescalarResultName
Properties
-
cee.ug.HitItem.anythingHit - anythingHit: boolean
Whether anything was hit during the action. If false, the other properties in this object will be undefined.
-
cee.ug.HitItem.elementArea - elementArea: number
The area of the element (if applicable)
-
cee.ug.HitItem.elementEdgeIndex - elementEdgeIndex: number
The local index (zero based) of the closest element edge to the actual intersection point in the data model on the server that was hit
-
cee.ug.HitItem.elementFaceIndex - elementFaceIndex: number
The local index (zero based) of the element face that was hit
-
cee.ug.HitItem.elementId - elementId: number
The id of the element in the data model on the server that was hit
-
cee.ug.HitItem.elementIndex - elementIndex: number
The index (zero based) of the element in the data model on the server that was hit
-
cee.ug.HitItem.elementNodeIndex - elementNodeIndex: number
The local index (zero based) of the closest element node to the actual intersection point in the data model on the server that was hit
-
cee.ug.HitItem.elementNodeResult - elementNodeResult: number
The scalar result in the closest element node. Only defined if the current result is per element node
-
cee.ug.HitItem.elementResult - elementResult: number
The scalar result in the element that was hit.
-
cee.ug.HitItem.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.
-
cee.ug.HitItem.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.
-
cee.ug.HitItem.elementType - elementType: string
The type of the element in the data model on the server that was hit, for example ‘Quad’, ‘Tetrahedron’, ‘Hexahedron’
-
cee.ug.HitItem.elementVolume - elementVolume: number
The volume of the element (if applicable)
-
cee.ug.HitItem.frameIndex - frameIndex: number
The index of the frame in which the picking occurred. This is 0 unless there is an animation.
-
cee.ug.HitItem.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.
-
cee.ug.HitItem.intersectionPoint - intersectionPoint:
Vec3The 3d point (in world coordinates) on the surface that was hit.
This is the actual point that was hit
-
cee.ug.HitItem.intersectionPointNormal - intersectionPointNormal:
Vec3The normal of the surface at the point where the surface was hit.
-
cee.ug.HitItem.intersectionPointResult - intersectionPointResult: number
The interpolated scalar result in the
intersectionPoint.
-
cee.ug.HitItem.nodeId - nodeId: number
The id of the closest node to the actual intersection point in the data model on the server that was hit
-
cee.ug.HitItem.nodeIndex - nodeIndex: number
The index (zero based) of the closest node to the actual intersection point in the data model on the server that was hit
-
cee.ug.HitItem.nodePosition - nodePosition:
Vec3The 3d point (in world coordinates) of the closest node as identified by nodeId/nodeIndex
Use intersectionPoint for the actual point on the model that was hit
-
cee.ug.HitItem.nodeResult - nodeResult: number
The scalar result in the closest node as indicated by
nodeId/nodeIndex.
-
cee.ug.HitItem.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.
-
cee.ug.HitItem.objectId - objectId: number
The id of the object (part/iso/cut/isovol) that was hit
-
cee.ug.HitItem.objectIndex - objectIndex: number
The index of the object (part/iso/cut/isovol) that was hit
-
cee.ug.HitItem.objectName - objectName: string
The name of the object (part/iso/cut/isovol) that was hit
-
cee.ug.HitItem.objectType - objectType:
ObjectTypeThe type of object (part/iso/cut/isovol) that was hit
-
cee.ug.HitItem.scalarResultName - scalarResultName: string
The name of the scalar that the results
elementResultandnodeResultapply to.
