.. role:: ts-api-decorator

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

.. js:module:: cee.vs
   :noindex:

.. container:: ts-api-section

   .. js:class:: HitItem

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

      Returned by ``StreamModel.rayIntersect``



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~cee.vs.HitItem.groupResourceKey`
   * :js:attr:`~cee.vs.HitItem.instanceIdx`
   * :js:attr:`~cee.vs.HitItem.instanceUserRef`
   * :js:attr:`~cee.vs.HitItem.intersectionPoint`
   * :js:attr:`~cee.vs.HitItem.intersectionPointNormal`
   * :js:attr:`~cee.vs.HitItem.meshUserRef`
   * :js:attr:`~cee.vs.HitItem.polygonCentroid`
   * :js:attr:`~cee.vs.HitItem.srcPolyId`
   * :js:attr:`~cee.vs.HitItem.srcVertexId`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: HitItem.groupResourceKey

      :type: string

      The resource key of the group that the hit's instance belongs to.



.. container:: ts-api-section

   .. js:attribute:: HitItem.instanceIdx

      :type: number

      An index of the instance hit within the ``groupResourceKey``.



.. container:: ts-api-section

   .. js:attribute:: HitItem.instanceUserRef

      :type: string

      The user assigned userRef string for the mesh instance that was hit.



.. container:: ts-api-section

   .. js:attribute:: HitItem.intersectionPoint

      :type: Vec3

      Intersection point of the hit in world coordinates.



.. container:: ts-api-section

   .. js:attribute:: HitItem.intersectionPointNormal

      :type: Vec3

      The normal at the intersectionPoint.



.. container:: ts-api-section

   .. js:attribute:: HitItem.meshUserRef

      :type: string

      The user specified userRef string of the referenced polygon's mesh.



.. container:: ts-api-section

   .. js:attribute:: HitItem.polygonCentroid

      :type: Vec3

      Centroid of the polygon which was hit.



.. container:: ts-api-section

   .. js:attribute:: HitItem.srcPolyId

      :type: number

      The source id of the polygon that was hit, -1 if not specified



.. container:: ts-api-section

   .. js:attribute:: HitItem.srcVertexId

      :type: number

      The source id of the closest vertex, -1 if not specified



