.. role:: ts-api-decorator

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

.. js:module:: cee.usg
   :noindex:

.. container:: ts-api-section

   .. js:class:: HitItem

      An object describing the result of a picking action on an ``UnstructGridModel``.

      Returned by ``UnstructGridModel.rayIntersect``



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~cee.usg.HitItem.closestNodeId`
   * :js:attr:`~cee.usg.HitItem.closestNodeIndex`
   * :js:attr:`~cee.usg.HitItem.closestNodePosition`
   * :js:attr:`~cee.usg.HitItem.elementId`
   * :js:attr:`~cee.usg.HitItem.elementIndex`
   * :js:attr:`~cee.usg.HitItem.elementNodeCount`
   * :js:attr:`~cee.usg.HitItem.intersectionPoint`
   * :js:attr:`~cee.usg.HitItem.intersectionPointNormal`
   * :js:attr:`~cee.usg.HitItem.partIndex`
   * :js:attr:`~cee.usg.HitItem.partName`
   * :js:attr:`~cee.usg.HitItem.stateIndex`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: HitItem.closestNodeId

      :type: number

      The id of the closest node in the element that was hit.



.. container:: ts-api-section

   .. js:attribute:: HitItem.closestNodeIndex

      :type: number

      The index of the closest node in the element that was hit



.. container:: ts-api-section

   .. js:attribute:: HitItem.closestNodePosition

      :type: Vec3

      The position of the closest node in the element that was hit



.. container:: ts-api-section

   .. js:attribute:: HitItem.elementId

      :type: number

      The id of the element that was hit.



.. container:: ts-api-section

   .. js:attribute:: HitItem.elementIndex

      :type: number

      The index of the element that was hit



.. container:: ts-api-section

   .. js:attribute:: HitItem.elementNodeCount

      :type: number

      The number of nodes in the element that was hit



.. container:: ts-api-section

   .. js:attribute:: HitItem.intersectionPoint

      :type: Vec3

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

      This is the actual point that was hit



.. container:: ts-api-section

   .. js:attribute:: HitItem.intersectionPointNormal

      :type: Vec3

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



.. container:: ts-api-section

   .. js:attribute:: HitItem.partIndex

      :type: number

      The index of the part that was hit



.. container:: ts-api-section

   .. js:attribute:: HitItem.partName

      :type: string

      The name of the part that was hit



.. container:: ts-api-section

   .. js:attribute:: HitItem.stateIndex

      :type: number

      The index of the state in which the geometry was hit



