
###
Ray
###

.. js:class:: common.Ray

   Object representing a Ray.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~common.Ray.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~common.Ray.direction`
   * :js:data:`~common.Ray.origin`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~common.Ray.assign`
   * :js:meth:`~common.Ray.copy`
   * :js:meth:`~common.Ray.negate`
   
   



.. rst-class:: kind-group kind-constructors

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


.. js:method:: common.Ray.constructor

      .. rst-class:: sig-pretty-signature
      
         | Ray(**origin**\ : :js:class:`Point3 <common.Point3>`\ , **direction**\ : :js:class:`Point3 <common.Point3>`\ ): :js:class:`Ray <common.Ray>`
      
      **Parameters**
      
      
         **origin**\ : :js:class:`Point3 <common.Point3>`
      
         **direction**\ : :js:class:`Point3 <common.Point3>`
      
      
      **Returns**\ : :js:class:`Ray <common.Ray>`
      



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

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


.. js:data:: common.Ray.direction

      .. rst-class:: sig-pretty-signature
      
         | direction: :js:class:`Point3 <common.Point3>`
      



.. js:data:: common.Ray.origin

      .. rst-class:: sig-pretty-signature
      
         | origin: :js:class:`Point3 <common.Point3>`
      



.. rst-class:: kind-group kind-methods

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


.. js:method:: common.Ray.assign

      .. rst-class:: sig-pretty-signature
      
         | assign(**ray**\ : :js:class:`Ray <common.Ray>`\ ): *this*
      
      Sets this ray equal to another ray
      
      **Parameters**
      
      
         **ray**\ : :js:class:`Ray <common.Ray>`
      
      
            the ray to assign
      
      
      
      **Returns**\ : *this*
      



.. js:method:: common.Ray.copy

      .. rst-class:: sig-pretty-signature
      
         | copy(): :js:class:`Ray <common.Ray>`
      
      Creates a copy of this ray
      
      **Returns**\ : :js:class:`Ray <common.Ray>`
      
      
         a copy of this ray object
      
      



.. js:method:: common.Ray.negate

      .. rst-class:: sig-pretty-signature
      
         | negate(): *this*
      
      Flips the ray's direction.
      
      **Returns**\ : *this*
      




