.. vale off



:class:`MechanicalGraphicsWrapper`
==================================

.. py:class:: ansys.mechanical.stubs.v242.Ansys.ACT.Common.Graphics.MechanicalGraphicsWrapper

   Bases: :py:obj:`object`


   
   Wrapper for Graphics in Mechanical.
















   ..
       !! processed by numpydoc !!


.. py:currentmodule:: MechanicalGraphicsWrapper

Overview
--------

.. tab-set::



   .. tab-item:: Methods

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

          * - :py:attr:`~CreatePixelPoint`
            - Creates a point from pixel coordinates (ie. window coordinates).
          * - :py:attr:`~CreateVector3D`
            - Create a 3D vector from world coordinates.
          * - :py:attr:`~CreateWorldPoint`
            - Create a point from world coordinates.
          * - :py:attr:`~Export3D`
            - Exports the current Graphics display in a 3d format to a file.
          * - :py:attr:`~ExportImage`
            - Exports the current graphics display to a 2D image file.
          * - :py:attr:`~ExportScreenToImage`
            - ExportScreenToImage method.
          * - :py:attr:`~ExportViewports`
            - Creates a composite of images exported from each open viewport.
          * - :py:attr:`~ForceResume`
            - Forces the scene to resume. Useful in interactive context (console) if a reference on an
          * - :py:attr:`~Redraw`
            - Forces the scene to redraw its content.
          * - :py:attr:`~Suspend`
            - Prevents the scene to redraw until the Resume controller method was called.


   .. tab-item:: Properties

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

          * - :py:attr:`~Camera`
            - Gets the camera.
          * - :py:attr:`~GlobalLegendSettings`
            - Gets the Global Graphics Legend Settings.
          * - :py:attr:`~KeyframeAnimationUtility`
            - A utility for creating animations based on keyframes.
          * - :py:attr:`~ModelViewManager`
            - An instance of the ModelViewManager.
          * - :py:attr:`~ResultAnimationOptions`
            - Gets the Global Result Animation options.
          * - :py:attr:`~Scene`
            - Gets the scene.
          * - :py:attr:`~SectionPlanes`
            - Returns the collection of section planes used by graphics
          * - :py:attr:`~Unit`
            - Gets the current graphics unit.
          * - :py:attr:`~ViewOptions`
            - Gets the Graphics View Options.







Property detail
---------------
.. py:property:: Camera
   :type: Optional[Ansys.ACT.Common.Graphics.MechanicalCameraWrapper]

   
   Gets the camera.
















   ..
       !! processed by numpydoc !!

.. py:property:: GlobalLegendSettings
   :type: Optional[Ansys.Mechanical.Graphics.GlobalLegendSettings]

   
   Gets the Global Graphics Legend Settings.
















   ..
       !! processed by numpydoc !!

.. py:property:: KeyframeAnimationUtility
   :type: Optional[Ansys.ACT.Common.Graphics.KeyframeAnimationUtility]

   
   A utility for creating animations based on keyframes.
















   ..
       !! processed by numpydoc !!

.. py:property:: ModelViewManager
   :type: Optional[Ansys.ACT.Interfaces.Graphics.IModelViewManager]

   
   An instance of the ModelViewManager.
















   ..
       !! processed by numpydoc !!

.. py:property:: ResultAnimationOptions
   :type: Optional[Ansys.Mechanical.Graphics.ResultAnimationOptions]

   
   Gets the Global Result Animation options.
















   ..
       !! processed by numpydoc !!

.. py:property:: Scene
   :type: Optional[Ansys.ACT.Interfaces.Graphics.IGraphicsCollection]

   
   Gets the scene.
















   ..
       !! processed by numpydoc !!

.. py:property:: SectionPlanes
   :type: Optional[Ansys.Mechanical.Graphics.SectionPlanes]

   
   Returns the collection of section planes used by graphics
















   ..
       !! processed by numpydoc !!

.. py:property:: Unit
   :type: Optional[str]

   
   Gets the current graphics unit.
















   ..
       !! processed by numpydoc !!

.. py:property:: ViewOptions
   :type: Optional[Ansys.Mechanical.Graphics.ViewOptions]

   
   Gets the Graphics View Options.
















   ..
       !! processed by numpydoc !!





Method detail
-------------
.. py:method:: CreatePixelPoint(x: int, y: int) -> Ansys.ACT.Interfaces.Graphics.IPixelPoint

   
   Creates a point from pixel coordinates (ie. window coordinates).

   ..
       !! processed by numpydoc !!

.. py:method:: CreateVector3D(x: float, y: float, z: float) -> Ansys.ACT.Interfaces.Graphics.IVector3D

   
   Create a 3D vector from world coordinates.

   ..
       !! processed by numpydoc !!

.. py:method:: CreateWorldPoint(x: float, y: float, z: float) -> Ansys.ACT.Interfaces.Graphics.IWorldPoint

   
   Create a point from world coordinates.

   ..
       !! processed by numpydoc !!

.. py:method:: Export3D(filePath: str, format3d: Ansys.Mechanical.DataModel.Enums.Graphics3DExportFormat, settings: Ansys.Mechanical.Graphics.Graphics3DExportSettings) -> None

   
   Exports the current Graphics display in a 3d format to a file.

   ..
       !! processed by numpydoc !!

.. py:method:: ExportImage(filePath: str, formatImage: Ansys.Mechanical.DataModel.Enums.GraphicsImageExportFormat, settings: Ansys.Mechanical.Graphics.GraphicsImageExportSettings) -> None

   
   Exports the current graphics display to a 2D image file.

   ..
       !! processed by numpydoc !!

.. py:method:: ExportScreenToImage(filePath: str) -> None

   
   ExportScreenToImage method.

   ..
       !! processed by numpydoc !!

.. py:method:: ExportViewports(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsImageExportFormat, settings: Ansys.Mechanical.Graphics.GraphicsViewportsExportSettings) -> None

   
   Creates a composite of images exported from each open viewport.

   ..
       !! processed by numpydoc !!

.. py:method:: ForceResume() -> None

.. code-block:: text

   Forces the scene to resume. Useful in interactive context (console) if a reference on an
   operation has been lost.

..
       !! processed by numpydoc !!

.. py:method:: Redraw() -> None

   
   Forces the scene to redraw its content.

   ..
       !! processed by numpydoc !!

.. py:method:: Suspend() -> Ansys.ACT.Interfaces.Graphics.ISuspendController

   
   Prevents the scene to redraw until the Resume controller method was called.

   ..
       !! processed by numpydoc !!



.. vale on