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

.. js:class:: cee.vs.HitItem

   An object describing the result of a picking action on a :js:class:`StreamModel <cee.vs.StreamModel>`\ .
   
   Returned by :js:meth:`StreamModel.rayIntersect <cee.vs.StreamModel.rayIntersect>`
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.vs.HitItem.groupResourceKey`
   * :js:data:`~cee.vs.HitItem.instanceIdx`
   * :js:data:`~cee.vs.HitItem.instanceUserRef`
   * :js:data:`~cee.vs.HitItem.intersectionPoint`
   * :js:data:`~cee.vs.HitItem.intersectionPointNormal`
   * :js:data:`~cee.vs.HitItem.meshUserRef`
   * :js:data:`~cee.vs.HitItem.polygonCentroid`
   * :js:data:`~cee.vs.HitItem.srcPolyId`
   * :js:data:`~cee.vs.HitItem.srcVertexId`
   
   



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

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


.. js:data:: cee.vs.HitItem.groupResourceKey

      .. rst-class:: sig-pretty-signature
      
         | groupResourceKey: *string*
      
      The resource key of the group that the hit's instance belongs to.
      



.. js:data:: cee.vs.HitItem.instanceIdx

      .. rst-class:: sig-pretty-signature
      
         | instanceIdx: *number*
      
      An index of the instance hit within the :js:data:`groupResourceKey <cee.vs.HitItem.groupResourceKey>`\ .
      



.. js:data:: cee.vs.HitItem.instanceUserRef

      .. rst-class:: sig-pretty-signature
      
         | instanceUserRef: *string*
      
      The user assigned userRef string for the mesh instance that was hit.
      



.. js:data:: cee.vs.HitItem.intersectionPoint

      .. rst-class:: sig-pretty-signature
      
         | intersectionPoint: :js:class:`Vec3 <cee.Vec3>`
      
      Intersection point of the hit in world coordinates.
      



.. js:data:: cee.vs.HitItem.intersectionPointNormal

      .. rst-class:: sig-pretty-signature
      
         | intersectionPointNormal: :js:class:`Vec3 <cee.Vec3>`
      
      The normal at the intersectionPoint.
      



.. js:data:: cee.vs.HitItem.meshUserRef

      .. rst-class:: sig-pretty-signature
      
         | meshUserRef: *string*
      
      The user specified userRef string of the referenced polygon's mesh.
      



.. js:data:: cee.vs.HitItem.polygonCentroid

      .. rst-class:: sig-pretty-signature
      
         | polygonCentroid: :js:class:`Vec3 <cee.Vec3>`
      
      Centroid of the polygon which was hit.
      



.. js:data:: cee.vs.HitItem.srcPolyId

      .. rst-class:: sig-pretty-signature
      
         | srcPolyId: *number*
      
      The source id of the polygon that was hit, -1 if not specified
      



.. js:data:: cee.vs.HitItem.srcVertexId

      .. rst-class:: sig-pretty-signature
      
         | srcVertexId: *number*
      
      The source id of the closest vertex, -1 if not specified
      




