State

class cee.usg.State()

A state connects a geometry to the results (scalar, vector, displacement and transformations) for a given time, frequency, load case etc.

A model can have an arbitrary number of states, but only one can be shown at any given time.

To create an animation you can create multiple states, and then only change the UnstructGridModel.currentStateIndex property to advance the animation.

A state must have one and only one geometry.

The state can also have a scalar, vector, displacement and transformation result.

For the results, you only have to specify the results for the parts that have results. Results are mapped to part via the zero based part index.

Index

Accessors

• geometry
• name
• referenceValue

Methods

• getBoundingBox
• getFringesResultRange
• getPartDisplacementsAt
• getPartFringesAt
• getPartTransformationAt
• getPartVectorsAt
• getVectorLengthRange
• removeAllPartDisplacements
• removeAllPartFringes
• removeAllPartTransformations
• removeAllPartVectors
• setPartDisplacementsAt
• setPartFringesAt
• setPartTransformationAt
• setPartVectorsAt

Accessors

cee.usg.State.geometry()

get geometry(): Geometry

The one and only geometry in this state

Returns: Geometry

set geometry(geometry: Geometry): void

Parameters

geometry: Geometry

Returns: void

cee.usg.State.name()

get name(): string

The user defined name of the state

Returns: string

set name(name: string): void

Parameters

name: string

Returns: void

cee.usg.State.referenceValue()

get referenceValue(): number

The user defined reference value of the state (time, frequency, load case index, etc)

Returns: number

set referenceValue(value: number): void

Parameters

value: number

Returns: void

Methods

cee.usg.State.getBoundingBox()

getBoundingBox(): BoundingBox

Returns the BoundingBox (in world coordinates) of the model.

Returns: BoundingBox

cee.usg.State.getFringesResultRange()

getFringesResultRange(): Range

Get the min/max value of the scalar result in this part.

Returns: Range

cee.usg.State.getPartDisplacementsAt()

getPartDisplacementsAt(partIndex: number): PartDisplacements

Get the displacement result at the given zero based index, otherwise null.

Parameters

partIndex: number

Returns: PartDisplacements

cee.usg.State.getPartFringesAt()

getPartFringesAt(partIndex: number): PartScalars

Returns the PartScalars defining the fringes result shown on the given part. Null when none is specified.

Parameters

partIndex: number

Returns: PartScalars

cee.usg.State.getPartTransformationAt()

getPartTransformationAt(partIndex: number): Mat4

Get the transformation matrix for the given part in this state, null if none is specified.

Parameters

partIndex: number

Returns: Mat4

cee.usg.State.getPartVectorsAt()

getPartVectorsAt(partIndex: number): PartVectors

Returns the PartVectors defining the vector result shown on the given part. Null if not specified.

Parameters

partIndex: number

Returns: PartVectors

cee.usg.State.getVectorLengthRange()

getVectorLengthRange(): Range

The range (min/max) of the vector lengths in all parts

Returns: Range

cee.usg.State.removeAllPartDisplacements()

removeAllPartDisplacements(): void

Remove all displacement results in this state

Returns: void

cee.usg.State.removeAllPartFringes()

removeAllPartFringes(): void

Remove all scalar fringes results from this state

Returns: void

cee.usg.State.removeAllPartTransformations()

removeAllPartTransformations(): void

Remove the transformation matrices for all parts in this state

Returns: void

cee.usg.State.removeAllPartVectors()

removeAllPartVectors(): void

Remove all vector results for all parts in this state

Returns: void

cee.usg.State.setPartDisplacementsAt()

setPartDisplacementsAt(partIndex: number, partDisplacements: PartDisplacements): void

Set the displacement result for the given part in this state

Note: The PartSettings.displacementVisible property must be true to show the result (default true)

Parameters

partIndex: number

partDisplacements: PartDisplacements

Returns: void

cee.usg.State.setPartFringesAt()

setPartFringesAt(partIndex: number, partFringes: PartScalars): void

Set the scalar result that should be shown as fringes for the given part in this state.

Note: The PartSettings.fringesVisible property must be true to show the result (default true)

Parameters

partIndex: number

partFringes: PartScalars

Returns: void

cee.usg.State.setPartTransformationAt()

setPartTransformationAt(partIndex: number, partTransformationMatrix: Mat4): void

Set the transformation result (matrix) for the given part in this state.

Parameters

partIndex: number

partTransformationMatrix: Mat4

Returns: void

cee.usg.State.setPartVectorsAt()

setPartVectorsAt(partIndex: number, partVectors: PartVectors): void

Set the vector result that should be shown as vector arrows for the given part in this state.

Note: The PartSettings.vectorsVisible property must be true to show the result (default true)

Parameters

partIndex: number

partVectors: PartVectors

Returns: void