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.

Constructors

constructor

Accessors

arrowHeadRelativeLength
arrowHeadRelativeRadius
arrowShaftRelativeRadius
name
scaleFactor
scaleMode
singleVectorColor

Methods

setScaleFactor

Constructors

VectorSettings.constructor()

Return type:: VectorSettings

Accessors

cee.usg.arrowHeadRelativeLength()

The length of the vector arrow head relative to the vector length.

Return type:: number

cee.usg.arrowHeadRelativeLength(headRelativeLength)

Arguments:

headRelativeLength (number) – None

Return type:

void

cee.usg.arrowHeadRelativeRadius()

The radius of the vector arrow head relative to the vector length.

Return type:: number

cee.usg.arrowHeadRelativeRadius(headRelativeRadius)

Arguments:

headRelativeRadius (number) – None

Return type:

void

cee.usg.arrowShaftRelativeRadius()

The radius of the vector arrow shaft relative to the vector length.

Return type:: number

cee.usg.arrowShaftRelativeRadius(shaftRelativeRadius)

Arguments:

shaftRelativeRadius (number) – None

Return type:

void

cee.usg.name()

The name of the vector result

Return type:: string

cee.usg.name(name)

Arguments:

name (string) – None

Return type:

void

cee.usg.scaleFactor()

Scaling factor to use on the vector result

Return type:: number

cee.usg.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

Return type:: ScaleMode

cee.usg.singleVectorColor()

The color of the vector arrows

Return type:: Color3

cee.usg.singleVectorColor(color)

Arguments:

color (Color3) – None

Return type:

void

Methods

setScaleFactor

VectorSettings.setScaleFactor(mode, scaleFactor)

Arguments:

mode (ScaleMode) – None
scaleFactor (number) – None

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

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

Return type:: void