.. vale off



:class:`MechanicalCameraWrapper`
================================

.. py:class:: ansys.mechanical.stubs.v241.Ansys.ACT.Common.Graphics.MechanicalCameraWrapper

   Bases: :py:obj:`object`


   
   Wrapper for Camera in Mechanical.
















   ..
       !! processed by numpydoc !!


.. py:currentmodule:: MechanicalCameraWrapper

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~GetAsString`
            - Retrieves the view commands as related to the application type as a string.
          * - :py:attr:`~Pan`
            - Shifts the camera position horizontally or vertically based on x and y quantities.
          * - :py:attr:`~Rotate`
            - Rotates the camera about an axis.
          * - :py:attr:`~SetFit`
            - Fits the view to the specified selection. If null is supplied, fits the view to the entire model.
          * - :py:attr:`~SetSpecificViewOrientation`
            - Sets a specific view orientation.
          * - :py:attr:`~Zoom`
            - Zooms in or out on the model.


   .. tab-item:: Properties

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~FocalPoint`
            - The focal point of the camera (coordinates are in the global coordinate system).
          * - :py:attr:`~SceneHeight`
            - Specifies the scene height (in length units) that will be projected and fit to the viewport.
          * - :py:attr:`~SceneWidth`
            - Specifies the scene width (in length units) that will be projected and fit to the viewport.
          * - :py:attr:`~UpVector`
            - The vector pointing up from the focal point.
          * - :py:attr:`~ViewVector`
            - The vector pointing from the focal point to the camera.







Property detail
---------------
.. py:property:: FocalPoint
   :type: Optional[Ansys.Mechanical.Graphics.Point]

   
   The focal point of the camera (coordinates are in the global coordinate system).
















   ..
       !! processed by numpydoc !!

.. py:property:: SceneHeight
   :type: Optional[Ansys.Core.Units.Quantity]

   
   Specifies the scene height (in length units) that will be projected and fit to the viewport.
















   ..
       !! processed by numpydoc !!

.. py:property:: SceneWidth
   :type: Optional[Ansys.Core.Units.Quantity]

   
   Specifies the scene width (in length units) that will be projected and fit to the viewport.
















   ..
       !! processed by numpydoc !!

.. py:property:: UpVector
   :type: Optional[Ansys.ACT.Math.Vector3D]

   
   The vector pointing up from the focal point.
















   ..
       !! processed by numpydoc !!

.. py:property:: ViewVector
   :type: Optional[Ansys.ACT.Math.Vector3D]

   
   The vector pointing from the focal point to the camera.
















   ..
       !! processed by numpydoc !!





Method detail
-------------
.. py:method:: GetAsString(appType: Ansys.Mechanical.DataModel.Enums.ApplicationType) -> str

   
   Retrieves the view commands as related to the application type as a string.

   ..
       !! processed by numpydoc !!

.. py:method:: Pan(x: Ansys.Core.Units.Quantity, y: Ansys.Core.Units.Quantity) -> None

   
   Shifts the camera position horizontally or vertically based on x and y quantities. 

   ..
       !! processed by numpydoc !!

.. py:method:: Rotate(angle: float, axis: Ansys.Mechanical.DataModel.Enums.CameraAxisType) -> None

   
   Rotates the camera about an axis.

   ..
       !! processed by numpydoc !!

.. py:method:: SetFit(sel: Ansys.ACT.Interfaces.Common.ISelectionInfo) -> None

   
   Fits the view to the specified selection. If null is supplied, fits the view to the entire model.

   ..
       !! processed by numpydoc !!

.. py:method:: SetSpecificViewOrientation(type: Ansys.Mechanical.DataModel.Enums.ViewOrientationType) -> None

   
   Sets a specific view orientation.

   ..
       !! processed by numpydoc !!

.. py:method:: Zoom(zoomVal: float) -> None

   
   Zooms in or out on the model. 

   ..
       !! processed by numpydoc !!



.. vale on