
###################
BatchedCameraValues
###################

.. js:class:: Animation.BatchedCameraValues

   A structure that holds interpolated animation data for a camera. See [[BatchedValues]].
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Animation.BatchedCameraValues.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~Animation.BatchedCameraValues.height`
   * :js:data:`~Animation.BatchedCameraValues.position`
   * :js:data:`~Animation.BatchedCameraValues.target`
   * :js:data:`~Animation.BatchedCameraValues.up`
   * :js:data:`~Animation.BatchedCameraValues.width`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Animation.BatchedCameraValues.apply`
   * :js:meth:`~Animation.BatchedCameraValues.clear`
   
   




Constructors
============

.. js:method:: Animation.BatchedCameraValues.constructor

   .. rst-class:: sig-pretty-signature
   
      | BatchedCameraValues(): :js:class:`BatchedCameraValues <Animation.BatchedCameraValues>`
   
   **Returns**\ : :js:class:`BatchedCameraValues <Animation.BatchedCameraValues>`
   





Properties
==========

.. js:data:: Animation.BatchedCameraValues.height

   .. rst-class:: sig-pretty-signature
   
      | height: (*None* \| *number*\ )
   
   The camera's field height, applied with [[Camera.setHeight]].
   



.. js:data:: Animation.BatchedCameraValues.position

   .. rst-class:: sig-pretty-signature
   
      | position: (*None* \| :js:class:`~Point3`\ )
   
   The camera's position, applied with [[Camera.setPosition]].
   



.. js:data:: Animation.BatchedCameraValues.target

   .. rst-class:: sig-pretty-signature
   
      | target: (*None* \| :js:class:`~Point3`\ )
   
   The camera's target, applied with [[Camera.setTarget]].
   



.. js:data:: Animation.BatchedCameraValues.up

   .. rst-class:: sig-pretty-signature
   
      | up: (*None* \| :js:class:`~Point3`\ )
   
   The camera's up vector, applied with [[Camera.setUp]].
   



.. js:data:: Animation.BatchedCameraValues.width

   .. rst-class:: sig-pretty-signature
   
      | width: (*None* \| *number*\ )
   
   The camera's field width, applied with [[Camera.setWidth]].
   





Methods
=======

.. js:method:: Animation.BatchedCameraValues.apply

   .. rst-class:: sig-pretty-signature
   
      | apply(**camera**\ : :js:class:`~Camera`\ ): *boolean*
   
   Set the stored values on the supplied [[Camera]].
   
   **Parameters**
   
      **camera**\ : :js:class:`~Camera`
   
   
   **Returns**\ : *boolean*
   
      True if the camera was modified.
   
   



.. js:method:: Animation.BatchedCameraValues.clear

   .. rst-class:: sig-pretty-signature
   
      | clear(): *void*
   
   Reset this object to its initial state.
   
   **Returns**\ : *void*
   





