
##############
MirrorSettings
##############

.. js:class:: cee.ug.MirrorSettings

   Settings for mirroring/symmetry in the RemoteModel.
   
   Use this class to recreate the full model if the simulation was run on a part of the model to save simulation time exploiting any symmetry in the model.
   
   You can access the mirror settings from the :js:func:`RemoteModel.mirrorSettings <cee.ug.RemoteModel.mirrorSettings>` property.
   
   **Example:** A forging simulation simulating only 1/6'th of the model.
   
   CAE model:
   
   .. image:: /images/mirror_single.png
      :alt: None
   
   
   
   Full model using mirroring with mirrorPassCount = 5:
   
   .. image:: /images/mirror_full.png
      :alt: None
   
   
   
   
   Index
   =====
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.ug.MirrorSettings.enable`
   * :js:func:`~cee.ug.MirrorSettings.firstPlane`
   * :js:func:`~cee.ug.MirrorSettings.masterPlane`
   * :js:func:`~cee.ug.MirrorSettings.mirrorPassCount`
   * :js:func:`~cee.ug.MirrorSettings.reflective`
   * :js:func:`~cee.ug.MirrorSettings.secondPlane`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.ug.MirrorSettings.getAsProperties`
   * :js:meth:`~cee.ug.MirrorSettings.setFromProperties`
   
   



.. rst-class:: kind-group kind-accessors

.. rubric:: Accessors
   :class: kind-group-title


.. js:method:: cee.ug.MirrorSettings.enable

      .. rst-class:: sig-pretty-signature
      
         | *get* enable(): *boolean*
      
      Enable or disable mirroring/symmetry
      
      If enabled, the model will be mirrored according to the given settings
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* enable(**enable**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **enable**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.MirrorSettings.firstPlane

      .. rst-class:: sig-pretty-signature
      
         | *get* firstPlane(): :js:class:`PlaneLike <cee.PlaneLike>`
      
      Set the first mirror plane to use. This plane will be used for the 1st mirror pass
      
      **Returns**\ : :js:class:`PlaneLike <cee.PlaneLike>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* firstPlane(**plane**\ : :js:class:`PlaneLike <cee.PlaneLike>`\ ): *void*
      
      **Parameters**
      
      
         **plane**\ : :js:class:`PlaneLike <cee.PlaneLike>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.MirrorSettings.masterPlane

      .. rst-class:: sig-pretty-signature
      
         | *get* masterPlane(): :js:class:`PlaneLike <cee.PlaneLike>`
      
      Set the master mirror plane to use.
      
      The master mirror plane will add one final mirroring that mirrors the entire model after doing the given number of mirror passes specified in the first/second plane and the mirrorPassCount.
      
      **Returns**\ : :js:class:`PlaneLike <cee.PlaneLike>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* masterPlane(**plane**\ : :js:class:`PlaneLike <cee.PlaneLike>`\ ): *void*
      
      **Parameters**
      
      
         **plane**\ : :js:class:`PlaneLike <cee.PlaneLike>`
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.MirrorSettings.mirrorPassCount

      .. rst-class:: sig-pretty-signature
      
         | *get* mirrorPassCount(): *number*
      
      The number of mirror passes to render.
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* mirrorPassCount(**numPasses**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **numPasses**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.MirrorSettings.reflective

      .. rst-class:: sig-pretty-signature
      
         | *get* reflective(): *boolean*
      
      Enable or disable reflective mirroring.
      
      If enabled, the mirrored parts will be reflected on plane1/plane2. If disabled, the part will only be rotated into place.
      
      **Returns**\ : *boolean*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* reflective(**useReflective**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **useReflective**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.ug.MirrorSettings.secondPlane

      .. rst-class:: sig-pretty-signature
      
         | *get* secondPlane(): :js:class:`PlaneLike <cee.PlaneLike>`
      
      Set the second mirror plane to use. This plane will be used for the 2nd mirror pass
      
      **Returns**\ : :js:class:`PlaneLike <cee.PlaneLike>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* secondPlane(**plane**\ : :js:class:`PlaneLike <cee.PlaneLike>`\ ): *void*
      
      **Parameters**
      
      
         **plane**\ : :js:class:`PlaneLike <cee.PlaneLike>`
      
      
      **Returns**\ : *void*
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: cee.ug.MirrorSettings.getAsProperties

      .. rst-class:: sig-pretty-signature
      
         | getAsProperties(): :js:class:`MirrorSettingsProperties <cee.ug.MirrorSettingsProperties>`
      
      Gets the settings for this object as a Plain Old JavaScript Object (POJO).
      
      **Returns**\ : :js:class:`MirrorSettingsProperties <cee.ug.MirrorSettingsProperties>`
      



.. js:method:: cee.ug.MirrorSettings.setFromProperties

      .. rst-class:: sig-pretty-signature
      
         | setFromProperties(**props**\ : *Partial*\ ): *void*
      
      Applies the settings in the given properties object to this scalar settings
      
      **Parameters**
      
      
         **props**\ : *Partial*
      
      
      **Returns**\ : *void*
      




