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

.. js:class:: cee.cug.HitItem

   An object describing the result of a picking action on a :js:class:`ConstantRemoteModel <cee.cug.ConstantRemoteModel>`\ .
   
   Returned by :js:meth:`ConstantRemoteModel.rayIntersect <cee.cug.ConstantRemoteModel.rayIntersect>`
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.cug.HitItem.elementId`
   * :js:data:`~cee.cug.HitItem.elementIndex`
   * :js:data:`~cee.cug.HitItem.elementLocalSurface`
   * :js:data:`~cee.cug.HitItem.elementScalarResult`
   * :js:data:`~cee.cug.HitItem.elementTriangleVertices`
   * :js:data:`~cee.cug.HitItem.elementType`
   * :js:data:`~cee.cug.HitItem.frameIndex`
   * :js:data:`~cee.cug.HitItem.intersectionPoint`
   * :js:data:`~cee.cug.HitItem.intersectionPointNormal`
   * :js:data:`~cee.cug.HitItem.nodeId`
   * :js:data:`~cee.cug.HitItem.nodeIndex`
   * :js:data:`~cee.cug.HitItem.nodePosition`
   * :js:data:`~cee.cug.HitItem.nodeScalarResult`
   * :js:data:`~cee.cug.HitItem.objectIndex`
   * :js:data:`~cee.cug.HitItem.objectType`
   * :js:data:`~cee.cug.HitItem.serverItemIdent`
   
   



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

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


.. js:data:: cee.cug.HitItem.elementId

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



.. js:data:: cee.cug.HitItem.elementIndex

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



.. js:data:: cee.cug.HitItem.elementLocalSurface

      .. rst-class:: sig-pretty-signature
      
         | elementLocalSurface: *number*
      
      The type of the element in the data model on the server that was hit, for example 'Quad', 'Tetrahedron', 'Hexahedron'
      



.. js:data:: cee.cug.HitItem.elementScalarResult

      .. rst-class:: sig-pretty-signature
      
         | elementScalarResult: *number*
      
      The scalar result in the closest node as indicated by :js:data:`nodeId <cee.cug.HitItem.nodeId>`\ /:js:data:`nodeIndex <cee.cug.HitItem.nodeIndex>`\ .
      



.. js:data:: cee.cug.HitItem.elementTriangleVertices

      .. rst-class:: sig-pretty-signature
      
         | 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.
      



.. js:data:: cee.cug.HitItem.elementType

      .. rst-class:: sig-pretty-signature
      
         | elementType: *string*
      
      The type of the element in the data model on the server that was hit, for example 'Quad', 'Tetrahedron', 'Hexahedron'
      



.. js:data:: cee.cug.HitItem.frameIndex

      .. rst-class:: sig-pretty-signature
      
         | frameIndex: *number*
      
      The index of the frame in which the picking occurred
      



.. js:data:: cee.cug.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.cug.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.cug.HitItem.nodeId

      .. rst-class:: sig-pretty-signature
      
         | nodeId: *number*
      
      The id of the node in the data model on the server that was hit
      



.. js:data:: cee.cug.HitItem.nodeIndex

      .. rst-class:: sig-pretty-signature
      
         | nodeIndex: *number*
      
      The index of the node in the data model on the server that was hit
      



.. js:data:: cee.cug.HitItem.nodePosition

      .. rst-class:: sig-pretty-signature
      
         | nodePosition: :js:class:`Vec3 <cee.Vec3>`
      
      The position of the node in the data model on the server that was hit
      



.. js:data:: cee.cug.HitItem.nodeScalarResult

      .. rst-class:: sig-pretty-signature
      
         | nodeScalarResult: *number*
      
      The scalar result in the closest node as indicated by :js:data:`nodeId <cee.cug.HitItem.nodeId>`\ /:js:data:`nodeIndex <cee.cug.HitItem.nodeIndex>`\ .
      



.. js:data:: cee.cug.HitItem.objectIndex

      .. rst-class:: sig-pretty-signature
      
         | objectIndex: *number*
      
      The index of the object (part/iso/cut/isovol) that was hit
      



.. js:data:: cee.cug.HitItem.objectType

      .. rst-class:: sig-pretty-signature
      
         | objectType: :js:data:`ObjectType <cee.cug.ObjectType>`
      
      The type of object (part/iso/cut/isovol) that was hit
      



.. js:data:: cee.cug.HitItem.serverItemIdent

      .. rst-class:: sig-pretty-signature
      
         | serverItemIdent: :js:class:`ServerItemIdent <cee.cug.ServerItemIdent>`
      
      Object identifying the hit item. Can be used for query
      




