UnstructGridModel

class cee.usg.UnstructGridModel()

The UnstructGridModel implements a client side model for handling surface CAE models.

It handles surface elements with any number of nodes. A model has one or more State which links a Geometry to scalar, displacement and transformation results for that geometry in that state.

Here is a simple example of how to create an usg model containing a single quad element with a per node scalar result in one state:

let model = new cee.usg.UnstructGridModel();
this.m_view.addModel(model);

let geometry = new cee.usg.Geometry();
let part = geometry.addPart();

// Create a single quad mesh
const nodeArr = [0,0,0, 1,0,0, 1,1,0, 0,1,0];
const elConnArr = [0,1,2,3];
part.mesh = new cee.usg.Mesh(nodeArr, 4, elConnArr);

// Configure the visual appearance of the part
part.settings.color = new cee.Color3(1,0,0);
part.settings.drawStyle = cee.usg.DrawStyle.SURFACE_MESH

// Create a state, set the geometry and add the scalar result
let state = model.addState();
state.geometry = geometry;

let scalarArr = [1,2,3,4];
state.setPartFringesAt(0, new cee.usg.PartScalars(cee.usg.ResultMapping.PER_NODE, scalarArr));

// Configure the mapper to use, and
const mapper = new cee.ScalarMapperFilledContoursUniform();
mapper.colorArray = cee.ColorTableFactory.color4TableArray(cee.ColorTable.NORMAL, 15);
mapper.setRange(1,4);
model.fringesSettings.scalarMapper = mapper;

// Add a color legend based on the mapper
this.m_view.overlay.addCustomColorLegendForScalarMapper(mapper, "Demo result", 1);

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

Constructors

• constructor

Accessors

• currentState

• currentStateIndex

• displacementSettings

• fringesSettings

• name

• stateCount

• vectorSettings

Methods

• addState

• deleteAllStates

• deleteStateAt

• deleteStateRange

• getBoundingBox

• getFringesResultRange

• getStateArray

• getStateAt

• rayIntersect

---

Constructors

constructor

cee.usg.UnstructGridModel.constructor(options)

Create the UnstructGridModel

Arguments

• options (cee.usg.UnstructGridModelOptions) –

Return type

cee.usg.UnstructGridModel

Use the options to set the resource usage strategy for the model in a multi-state scenario. See UnstructGridModelOptions for more info.

Accessors

cee.usg.UnstructGridModel.currentState

The zero based index of the state currently shown in the view

cee.usg.UnstructGridModel.currentStateIndex

The state to show in the view.

The given zero-based index must be between 0 and stateCount - 1.

cee.usg.UnstructGridModel.displacementSettings

Settings for the displacement results

cee.usg.UnstructGridModel.fringesSettings

Settings for the scalars shown as fringes on the model

cee.usg.UnstructGridModel.name

The name of the geometry model. Mainly used for debugging.

cee.usg.UnstructGridModel.stateCount

Returns the number of states in this model

cee.usg.UnstructGridModel.vectorSettings

Settings for the scalars shown as fringes on the model

Methods

addState

cee.usg.UnstructGridModel.addState()

Add a state to the model.

Return type

cee.usg.State

The added state is returned.

deleteAllStates

cee.usg.UnstructGridModel.deleteAllStates()

Delete all states in the model.

Return type

void

deleteStateAt

cee.usg.UnstructGridModel.deleteStateAt(stateIndex)

Delete a state at the given zero based index.

Arguments

• stateIndex (number) –

Return type

void

deleteStateRange

cee.usg.UnstructGridModel.deleteStateRange(startIndex, deleteCount)

Delete a range of states. First state that will be deleted is the state with the given index If deleteCount is omitted, all states starting with the given index will be deleted.

Arguments

• startIndex (number) –

• deleteCount (number) –

Return type

void

Works similar to the splice method on Javascript arrays

getBoundingBox

cee.usg.UnstructGridModel.getBoundingBox()

Returns the BoundingBox (in world coordinates) of the current state within the model.

Return type

cee.BoundingBox

getFringesResultRange

cee.usg.UnstructGridModel.getFringesResultRange()

Get the range of the scalar result in this model

Return type

cee.Range

getStateArray

cee.usg.UnstructGridModel.getStateArray()

Returns a readonly array of all the states in the model

Return type

ReadonlyArray[cee.usg.State]

getStateAt

cee.usg.UnstructGridModel.getStateAt(stateIndex)

Returns a reference to the state at the given index

Arguments

• stateIndex (number) –

Return type

cee.usg.State

rayIntersect

cee.usg.UnstructGridModel.rayIntersect(ray)

Performs picking on the model in the current state.

Arguments

• ray (cee.Ray) –

Return type

cee.usg.HitItem

If something was hit, returns a HitItem containing information about the part and primitive that was hit.

If nothing was hit, returns null.