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:

Index

Accessors

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

Methods

• getAsProperties
• setFromProperties

Accessors

cee.ug.Isovolume.computeFromVisibleParts()

get computeFromVisibleParts(): boolean

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.

Returns: boolean

set computeFromVisibleParts(visiblePartsOnly: boolean): void

Parameters

visiblePartsOnly: boolean

Returns: void

cee.ug.Isovolume.highlight()

get highlight(): boolean

Whether the isovolume should be highlighted.

Returns: boolean

set highlight(highlight: boolean): void

Parameters

highlight: boolean

Returns: void

cee.ug.Isovolume.id()

get id(): number

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

Returns: number

cee.ug.Isovolume.isoScalarResultId()

get isoScalarResultId(): number

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

Returns: number

set isoScalarResultId(isoScalarResultId: number): void

Parameters

isoScalarResultId: number

Returns: void

cee.ug.Isovolume.isPrecomputed()

get isPrecomputed(): boolean

Is true if the isovolume is precomputed and cannot be changed

Returns: boolean

cee.ug.Isovolume.mapScalarResultId()

get mapScalarResultId(): number

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.

Returns: number

set mapScalarResultId(mapScalarResultId: number): void

Parameters

mapScalarResultId: number

Returns: void

cee.ug.Isovolume.mapVectorResultId()

get mapVectorResultId(): number

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.

Returns: number

set mapVectorResultId(mapVectorResultId: number): void

Parameters

mapVectorResultId: number

Returns: void

cee.ug.Isovolume.maximumIsoValue()

get maximumIsoValue(): number

The maximum scalar value within the isovolume.

Returns: number

set maximumIsoValue(maximumIsoValue: number): void

Parameters

maximumIsoValue: number

Returns: void

cee.ug.Isovolume.minimumIsoValue()

get minimumIsoValue(): number

The minimum scalar value within isovolume.

Returns: number

set minimumIsoValue(minimumIsoValue: number): void

Parameters

minimumIsoValue: number

Returns: void

cee.ug.Isovolume.opacity()

get opacity(): number

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

Returns: number

set opacity(opacity: number): void

Parameters

opacity: number

Returns: void

cee.ug.Isovolume.visible()

get visible(): boolean

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

Returns: boolean

set visible(visible: boolean): void

Parameters

visible: boolean

Returns: void

cee.ug.Isovolume.volumeColor()

get volumeColor(): Color3Like

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

Returns: Color3Like

set volumeColor(clr: Color3Like): void

Parameters

clr: Color3Like

Returns: void

Methods

cee.ug.Isovolume.getAsProperties()

getAsProperties(): IsovolumeProperties

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

Returns: IsovolumeProperties

cee.ug.Isovolume.setFromProperties()

setFromProperties(props: Partial): void

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

Parameters

props: Partial

Returns: void