.. role:: ts-api-decorator

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

.. js:module:: Animation
   :noindex:

.. container:: ts-api-section

   .. js:class:: BatchedCameraValues

      A structure that holds interpolated animation data for a camera. See
      [[BatchedValues]].



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~Animation.BatchedCameraValues.constructor`



.. container:: api-index-section

   .. rubric:: Properties

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

   * :js:attr:`~Animation.BatchedCameraValues.height`
   * :js:attr:`~Animation.BatchedCameraValues.position`
   * :js:attr:`~Animation.BatchedCameraValues.target`
   * :js:attr:`~Animation.BatchedCameraValues.up`
   * :js:attr:`~Animation.BatchedCameraValues.width`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Animation.BatchedCameraValues.apply`
   * :js:meth:`~Animation.BatchedCameraValues.clear`





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

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

.. container:: ts-api-section

   .. js:function:: BatchedCameraValues.constructor()



      :rtype: BatchedCameraValues



Properties
==========

.. container:: ts-api-section

   .. js:attribute:: BatchedCameraValues.height

      :type: null | number

      The camera's field height, applied with [[Camera.setHeight]].



.. container:: ts-api-section

   .. js:attribute:: BatchedCameraValues.position

      :type: null | Point3

      The camera's position, applied with [[Camera.setPosition]].



.. container:: ts-api-section

   .. js:attribute:: BatchedCameraValues.target

      :type: null | Point3

      The camera's target, applied with [[Camera.setTarget]].



.. container:: ts-api-section

   .. js:attribute:: BatchedCameraValues.up

      :type: null | Point3

      The camera's up vector, applied with [[Camera.setUp]].



.. container:: ts-api-section

   .. js:attribute:: BatchedCameraValues.width

      :type: null | number

      The camera's field width, applied with [[Camera.setWidth]].



Methods
=======

.. rst-class:: ts-api-section

apply
-----

.. js:method:: BatchedCameraValues.apply( camera)

   :param camera: None
   :type camera: Camera


   Set the stored values on the supplied [[Camera]].

   :returns: True if the camera was modified.


   :rtype: boolean

.. rst-class:: ts-api-section

clear
-----

.. js:method:: BatchedCameraValues.clear()



   Reset this object to its initial state.


   :rtype: void

