# MirrorSettings

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

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

  CAE model:

  Full model using mirroring with mirrorPassCount = 5:

Accessors

- `enable`
- `firstPlane`
- `masterPlane`
- `mirrorPassCount`
- `reflective`
- `secondPlane`

Methods

- `getAsProperties`
- `setFromProperties`

## Accessors

`MirrorSettings.``enable`()

  Enable or disable mirroring/symmetry

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

  Return type: | boolean

`MirrorSettings.``enable`(enable)

  Arguments: | enable (`boolean`) – None
  Return type: | void

`MirrorSettings.``firstPlane`()

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

  Return type: | PlaneLike

`MirrorSettings.``firstPlane`(plane)

  Arguments: | plane (`PlaneLike`) – None
  Return type: | void

`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.

  Return type: | PlaneLike

`MirrorSettings.``masterPlane`(plane)

  Arguments: | plane (`PlaneLike`) – None
  Return type: | void

`MirrorSettings.``mirrorPassCount`()

  The number of mirror passes to render.

  Return type: | number

`MirrorSettings.``mirrorPassCount`(numPasses)

  Arguments: | numPasses (`number`) – None
  Return type: | void

`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.

  Return type: | boolean

`MirrorSettings.``reflective`(useReflective)

  Arguments: | useReflective (`boolean`) – None
  Return type: | void

`MirrorSettings.``secondPlane`()

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

  Return type: | PlaneLike

`MirrorSettings.``secondPlane`(plane)

  Arguments: | plane (`PlaneLike`) – None
  Return type: | void

## Methods

### getAsProperties

`MirrorSettings.``getAsProperties`()

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

  Return type: | MirrorSettingsProperties

### setFromProperties

`MirrorSettings.``setFromProperties`(props)

  Arguments: | props (`Partial`) – None

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

  Return type: | void

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Envision for Web or choose a sample question below to start a conversation:

What is HOOPS Envision for Web?
What are the latest release notes for HOOPS Envision for Web?
How do I start evaluating HOOPS Envision for Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...