======
Camera
======

.. py:currentmodule:: p3dsdk

.. py:class:: Camera


   .. py:method:: id
      :property:

      The id of the camera.

      :type: str, read-only

   .. py:method:: name
      :property:

      The name of the camera.

      :type: str
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: group
      :property:

      The group of this camera or :py:obj:`None` if the camera is at the root of the hierarchy.

      :type: CameraGroup or None
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: sensor
      :property:

      The sensor of this camera or :py:obj:`None` if the camera uses the default sensor.

      :type: Sensor or None
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: fov_x
      :property:

      The horizontal field of view (in degrees).

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: fov_y
      :property:

      The vertial field of view (in degrees).

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: view_from
      :property:

      The origin point of the camera.

      :type: Vector3
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: view_to
      :property:

      The view point of the camera.

      :type: Vector3
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: view_up
      :property:

      The up vector of the camera.

      :type: Vector3
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: exposed_in_configuration
      :property:

      Whether the camera is exposed in configuration.

      :type: bool
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: lens_shift_x
      :property:

      The horizontal lens shift value.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.

   .. py:method:: lens_shift_y
      :property:

      The vertical lens shift value.

      :type: float
      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.


   .. py:method:: remove()

      Delete a camera.



      :raises ReadOnlyError: If :py:obj:`Database` is in read only mode.