
#######
HitItem
#######

.. js:class:: cee.usg.HitItem

   An object describing the result of a picking action on an :js:class:`UnstructGridModel <cee.usg.UnstructGridModel>`\ .
   
   Returned by :js:meth:`UnstructGridModel.rayIntersect <cee.usg.UnstructGridModel.rayIntersect>`
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.usg.HitItem.closestNodeId`
   * :js:data:`~cee.usg.HitItem.closestNodeIndex`
   * :js:data:`~cee.usg.HitItem.closestNodePosition`
   * :js:data:`~cee.usg.HitItem.elementId`
   * :js:data:`~cee.usg.HitItem.elementIndex`
   * :js:data:`~cee.usg.HitItem.elementNodeCount`
   * :js:data:`~cee.usg.HitItem.intersectionPoint`
   * :js:data:`~cee.usg.HitItem.intersectionPointNormal`
   * :js:data:`~cee.usg.HitItem.partIndex`
   * :js:data:`~cee.usg.HitItem.partName`
   * :js:data:`~cee.usg.HitItem.stateIndex`
   
   



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.usg.HitItem.closestNodeId

      .. rst-class:: sig-pretty-signature
      
         | closestNodeId: *number*
      
      The id of the closest node in the element that was hit.
      



.. js:data:: cee.usg.HitItem.closestNodeIndex

      .. rst-class:: sig-pretty-signature
      
         | closestNodeIndex: *number*
      
      The index of the closest node in the element that was hit
      



.. js:data:: cee.usg.HitItem.closestNodePosition

      .. rst-class:: sig-pretty-signature
      
         | closestNodePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the closest node in the element that was hit
      



.. js:data:: cee.usg.HitItem.elementId

      .. rst-class:: sig-pretty-signature
      
         | elementId: *number*
      
      The id of the element that was hit.
      



.. js:data:: cee.usg.HitItem.elementIndex

      .. rst-class:: sig-pretty-signature
      
         | elementIndex: *number*
      
      The index of the element that was hit
      



.. js:data:: cee.usg.HitItem.elementNodeCount

      .. rst-class:: sig-pretty-signature
      
         | elementNodeCount: *number*
      
      The number of nodes in the element that was hit
      



.. js:data:: cee.usg.HitItem.intersectionPoint

      .. rst-class:: sig-pretty-signature
      
         | intersectionPoint: :js:class:`Vec3 <cee.Vec3>`
      
      The 3d point (in world coordinates) on the surface that was hit.
      
      This is the actual point that was hit
      



.. js:data:: cee.usg.HitItem.intersectionPointNormal

      .. rst-class:: sig-pretty-signature
      
         | intersectionPointNormal: :js:class:`Vec3 <cee.Vec3>`
      
      The normal of the surface at the point where the surface was hit.
      



.. js:data:: cee.usg.HitItem.partIndex

      .. rst-class:: sig-pretty-signature
      
         | partIndex: *number*
      
      The index of the part that was hit
      



.. js:data:: cee.usg.HitItem.partName

      .. rst-class:: sig-pretty-signature
      
         | partName: *string*
      
      The name of the part that was hit
      



.. js:data:: cee.usg.HitItem.stateIndex

      .. rst-class:: sig-pretty-signature
      
         | stateIndex: *number*
      
      The index of the state in which the geometry was hit
      




