# Isovolume

class `cee.ug.``Isovolume`()

  Specification of an isovolume (both parameters and attributes) in a `RemoteModel`.

  Use this object to control the settings and attributes of an isovolume. An isovolume is defined as the combined volume of an element model where a scalar field is between a given minimum and maximum value. The surface of the isovolume is the hull of this volume. Any element on the border of the model (a surface with no neighbor) is also included in the volume if the scalar value on that surface is within the given range.

  You can map any scalar result onto the isovolume with `mapScalarResultId` and any vector result with `mapVectorResultId`. The settings for the mapped results can be changed with the `ScalarSettings` and `VectorSettings` objects.

  To create an isovolume, use `RemoteModel.addIsovolume`.

  Example: Show an isovolume

      var modelDir = myModel.modelDirectory;

      // Add isovolume if we have a scalar result
      if (modelDir.scalarResultArray.length > 0) {
          var iso = myModel.addIsovolume();
          iso.isoScalarResultId = modelDir.scalarResultArray[0].id;

          iso.minimumIsoValue = 2;
          iso.maximumIsoValue = 5;

          if (modelDir.scalarResultArray.length > 1) {
              iso.mapScalarResultId = modelDir.scalarResultArray[1].id;
          } else {
              iso.mapScalarResultId = modelDir.scalarResultArray[0].id;
          }
      }

      // Set model to outline to show the cutting planes
      myModel.setDrawStyleAllParts(cee.ug.DrawStyle.OUTLINE);

  This code sample produces the following image in the 3D Viewer:

Accessors

- `computeFromVisibleParts`
- `highlight`
- `id`
- `isPrecomputed`
- `isoScalarResultId`
- `mapScalarResultId`
- `mapVectorResultId`
- `maximumIsoValue`
- `minimumIsoValue`
- `opacity`
- `visible`
- `volumeColor`

Methods

- `getAsProperties`
- `setFromProperties`

## Accessors

`Isovolume.``computeFromVisibleParts`()

  If set to true, the isovolume will be computed from only the visible parts. Any part that is not visible will not contribute to the isovolume.

  Return type: | boolean

`Isovolume.``computeFromVisibleParts`(visiblePartsOnly)

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

`Isovolume.``highlight`()

  Whether the isovolume should be highlighted.

  Return type: | boolean

`Isovolume.``highlight`(highlight)

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

`Isovolume.``id`()

  The id of the isovolume. This is assigned by the system when you call `RemoteModel.addIsovolume` and is used to identify the isovolume.

  Return type: | number

`Isovolume.``isPrecomputed`()

  Is true if the isovolume is precomputed and cannot be changed

  Return type: | boolean

`Isovolume.``isoScalarResultId`()

  The scalar result to compute the isovolume from. This property is mandatory and must refer to one of the scalar results in `ModelDirectory.scalarResultArray`.

  Return type: | number

`Isovolume.``isoScalarResultId`(isoScalarResultId)

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

`Isovolume.``mapScalarResultId`()

  The id of the scalar result to show on the isovolume.

  This id must refer to one of the scalar results in `ModelDirectory.scalarResultArray`. You can change the settings for the scalar with the `ScalarSettings` object.

  Set to -1 to show no scalars on the isovolume.

  Return type: | number

`Isovolume.``mapScalarResultId`(mapScalarResultId)

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

`Isovolume.``mapVectorResultId`()

  The id of the vector result to show on the isovolume. One vector will be shown in each node of the surface.

  This id must refer to one of the vector results in `ModelDirectory.vectorResultArray`. The settings for the vector arrows can be changed with the `VectorSettings` object.

  Set to -1 to show no vectors on the isovolume.

  Return type: | number

`Isovolume.``mapVectorResultId`(mapVectorResultId)

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

`Isovolume.``maximumIsoValue`()

  The maximum scalar value within the isovolume.

  Return type: | number

`Isovolume.``maximumIsoValue`(maximumIsoValue)

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

`Isovolume.``minimumIsoValue`()

  The minimum scalar value within isovolume.

  Return type: | number

`Isovolume.``minimumIsoValue`(minimumIsoValue)

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

`Isovolume.``opacity`()

  Opacity of the isovolume. 0.0 means fully transparent (invisible), 1.0 means fully opaque.

  Return type: | number

`Isovolume.``opacity`(opacity)

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

`Isovolume.``visible`()

  Visibility of the isovolume. Use this to show or hide an isovolume in the 3D Viewer.

  Return type: | boolean

`Isovolume.``visible`(visible)

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

`Isovolume.``volumeColor`()

  The color of the isovolume if not showing a result (mapScalarResultId = -1)

  Return type: | Color3Like

`Isovolume.``volumeColor`(clr)

  Arguments: | clr (`Color3Like`) – None
  Return type: | void

## Methods

### getAsProperties

`Isovolume.``getAsProperties`()

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

  Return type: | IsovolumeProperties

### setFromProperties

`Isovolume.``setFromProperties`(props)

  Arguments: | props (`Partial`) – None

  Applies the settings in the given properties object to this isovolume.

  Return type: | void

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Web in your own language, 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...