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

cee.usg.VectorSettings.constructor()
VectorSettings(): VectorSettings

Returns: VectorSettings

Accessors

cee.usg.VectorSettings.arrowHeadRelativeLength()
get arrowHeadRelativeLength(): number

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

Returns: number

set arrowHeadRelativeLength(headRelativeLength: number): void

Parameters

headRelativeLength: number

Returns: void

cee.usg.VectorSettings.arrowHeadRelativeRadius()
get arrowHeadRelativeRadius(): number

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

Returns: number

set arrowHeadRelativeRadius(headRelativeRadius: number): void

Parameters

headRelativeRadius: number

Returns: void

cee.usg.VectorSettings.arrowShaftRelativeRadius()
get arrowShaftRelativeRadius(): number

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

Returns: number

set arrowShaftRelativeRadius(shaftRelativeRadius: number): void

Parameters

shaftRelativeRadius: number

Returns: void

cee.usg.VectorSettings.name()
get name(): string

The name of the vector result

Returns: string

set name(name: string): void

Parameters

name: string

Returns: void

cee.usg.VectorSettings.scaleFactor()
get scaleFactor(): number

Scaling factor to use on the vector result

Returns: number

cee.usg.VectorSettings.scaleMode()
get scaleMode(): 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

Returns: ScaleMode

cee.usg.VectorSettings.singleVectorColor()
get singleVectorColor(): Color3

The color of the vector arrows

Returns: Color3

set singleVectorColor(color: Color3): void

Parameters

color: Color3

Returns: void

Methods

cee.usg.VectorSettings.setScaleFactor()
setScaleFactor(mode: ScaleMode, scaleFactor: number): void

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

Parameters

mode: ScaleMode

scaleFactor: number

Returns: void