# 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

`VectorSettings.``arrowHeadRelativeLength`()

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

  Return type: | number

`VectorSettings.``arrowHeadRelativeLength`(headRelativeLength)

  Arguments: | headRelativeLength (`number`) – None
  Return type: | void

`VectorSettings.``arrowHeadRelativeRadius`()

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

  Return type: | number

`VectorSettings.``arrowHeadRelativeRadius`(headRelativeRadius)

  Arguments: | headRelativeRadius (`number`) – None
  Return type: | void

`VectorSettings.``arrowShaftRelativeRadius`()

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

  Return type: | number

`VectorSettings.``arrowShaftRelativeRadius`(shaftRelativeRadius)

  Arguments: | shaftRelativeRadius (`number`) – None
  Return type: | void

`VectorSettings.``name`()

  The name of the vector result

  Return type: | string

`VectorSettings.``name`(name)

  Arguments: | name (`string`) – None
  Return type: | void

`VectorSettings.``scaleFactor`()

  Scaling factor to use on the vector result

  Return type: | number

`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

  Return type: | ScaleMode

`VectorSettings.``singleVectorColor`()

  The color of the vector arrows

  Return type: | Color3

`VectorSettings.``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

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Envision for Web or choose a sample question below to start a conversation:

What is HOOPS Envision for Web?
What are the latest release notes for HOOPS Envision for Web?
How do I start evaluating HOOPS Envision for Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...