.. role:: ts-api-decorator

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

.. js:module:: cee.ug
   :noindex:

.. container:: ts-api-section

   .. js:class:: 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 ``RemoteModel.mirrorSettings`` property.

      **Example:** A forging simulation simulating only 1/6'th of the model.

      CAE model:

      .. image:: ../../images/mirror_single.png

 

      Full model using mirroring with mirrorPassCount = 5:

      .. image:: ../../images/mirror_full.png





.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.ug.MirrorSettings.enable`
   * :js:attr:`~cee.ug.MirrorSettings.firstPlane`
   * :js:attr:`~cee.ug.MirrorSettings.masterPlane`
   * :js:attr:`~cee.ug.MirrorSettings.mirrorPassCount`
   * :js:attr:`~cee.ug.MirrorSettings.reflective`
   * :js:attr:`~cee.ug.MirrorSettings.secondPlane`



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~cee.ug.MirrorSettings.getAsProperties`
   * :js:meth:`~cee.ug.MirrorSettings.setFromProperties`





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

Accessors
=========

.. container:: ts-api-section

   .. js:function:: MirrorSettings.enable()



      Enable or disable mirroring/symmetry

      If enabled, the model will be mirrored according to the given settings


      :rtype: boolean

   .. js:function:: MirrorSettings.enable( enable)

      :param enable: None
      :type enable: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: MirrorSettings.firstPlane()



      Set the first mirror plane to use. This plane will be used for the 1st mirror pass


      :rtype: PlaneLike

   .. js:function:: MirrorSettings.firstPlane( plane)

      :param plane: None
      :type plane: PlaneLike


      :rtype: void



.. container:: ts-api-section

   .. js:function:: MirrorSettings.masterPlane()



      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.


      :rtype: PlaneLike

   .. js:function:: MirrorSettings.masterPlane( plane)

      :param plane: None
      :type plane: PlaneLike


      :rtype: void



.. container:: ts-api-section

   .. js:function:: MirrorSettings.mirrorPassCount()



      The number of mirror passes to render.


      :rtype: number

   .. js:function:: MirrorSettings.mirrorPassCount( numPasses)

      :param numPasses: None
      :type numPasses: number


      :rtype: void



.. container:: ts-api-section

   .. js:function:: MirrorSettings.reflective()



      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.


      :rtype: boolean

   .. js:function:: MirrorSettings.reflective( useReflective)

      :param useReflective: None
      :type useReflective: boolean


      :rtype: void



.. container:: ts-api-section

   .. js:function:: MirrorSettings.secondPlane()



      Set the second mirror plane to use. This plane will be used for the 2nd mirror pass


      :rtype: PlaneLike

   .. js:function:: MirrorSettings.secondPlane( plane)

      :param plane: None
      :type plane: PlaneLike


      :rtype: void



Methods
=======

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

getAsProperties
---------------

.. js:method:: MirrorSettings.getAsProperties()



   Gets the settings for this object as a Plain Old JavaScript Object (POJO).


   :rtype: MirrorSettingsProperties

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

setFromProperties
-----------------

.. js:method:: MirrorSettings.setFromProperties( props)

   :param props: None
   :type props: Partial <MirrorSettingsProperties>


   Applies the settings in the given properties object to this scalar settings


   :rtype: void

