VectorSettings

class cee.usg.VectorSettings()

Setting for how a vector result should be shown in the model.

You can get the vector settings with the UnstructGridModel.vectorSettings property.

Accessors

name
scaleFactor
scaleMode
singleVectorColor

Methods

setScaleFactor

Accessors

cee.usg.VectorSettings.name: The name of the vector result

cee.usg.VectorSettings.scaleFactor: Scaling factor to use on the vector result

cee.usg.VectorSettings.scaleMode

Scaling mode (absolute or relative) to use use for the vector result

If set to ABSOLUTE_SCALING, the vector result will be multiplied by the scaling factor.

If set to RELATIVE_SCALING, the scaling factor is assumed to be a fraction of the extent of the model bounding box, making the longest vector: boundingBox.extent().length()*scaleFactor

cee.usg.VectorSettings.singleVectorColor: The color of the vector arrows

Methods

setScaleFactor

cee.usg.VectorSettings.setScaleFactor(mode, scaleFactor)

Set the scaling factor and scaling mode to use on the vector result

Arguments

mode (cee.usg.ScaleMode) –
scaleFactor (number) –

Return type

void

If mode is ABSOLUTE_SCALING, the vector result will be multiplied by the scaleFactor.

If mode is RELATIVE_SCALING, the scaleFactor is assumed to be a fraction of the extent of the model bounding box, making the longest vector: boundingBox.extent().length()*scaleFactor