Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VectorSettings

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

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

Hierarchy

  • VectorSettings

Index

Accessors

name

name: string

The name of the vector result

Readonly scaleFactor

scaleFactor: number

Scaling factor to use on the vector result

Readonly scaleMode

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

singleVectorColor

singleVectorColor: Color3

The color of the vector arrows

Methods

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

    Returns void

Generated using TypeDoc