
##############
VectorSettings
##############

.. js:class:: cee.usg.VectorSettings

   Setting for how a vector result should be shown in the model.
   
   You can get the vector settings with the :js:func:`UnstructGridModel.vectorSettings <cee.usg.UnstructGridModel.vectorSettings>` property.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.usg.VectorSettings.constructor`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.usg.VectorSettings.arrowHeadRelativeLength`
   * :js:func:`~cee.usg.VectorSettings.arrowHeadRelativeRadius`
   * :js:func:`~cee.usg.VectorSettings.arrowShaftRelativeRadius`
   * :js:func:`~cee.usg.VectorSettings.name`
   * :js:func:`~cee.usg.VectorSettings.scaleFactor`
   * :js:func:`~cee.usg.VectorSettings.scaleMode`
   * :js:func:`~cee.usg.VectorSettings.singleVectorColor`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~cee.usg.VectorSettings.setScaleFactor`
   
   



.. rst-class:: kind-group kind-constructors

.. rubric:: Constructors
   :class: kind-group-title


.. js:method:: cee.usg.VectorSettings.constructor

      .. rst-class:: sig-pretty-signature
      
         | VectorSettings(): :js:class:`VectorSettings <cee.usg.VectorSettings>`
      
      **Returns**\ : :js:class:`VectorSettings <cee.usg.VectorSettings>`
      



.. rst-class:: kind-group kind-accessors

.. rubric:: Accessors
   :class: kind-group-title


.. js:method:: cee.usg.VectorSettings.arrowHeadRelativeLength

      .. rst-class:: sig-pretty-signature
      
         | *get* arrowHeadRelativeLength(): *number*
      
      The length of the vector arrow head relative to the vector length.
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* arrowHeadRelativeLength(**headRelativeLength**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **headRelativeLength**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.VectorSettings.arrowHeadRelativeRadius

      .. rst-class:: sig-pretty-signature
      
         | *get* arrowHeadRelativeRadius(): *number*
      
      The radius of the vector arrow head relative to the vector length.
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* arrowHeadRelativeRadius(**headRelativeRadius**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **headRelativeRadius**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.VectorSettings.arrowShaftRelativeRadius

      .. rst-class:: sig-pretty-signature
      
         | *get* arrowShaftRelativeRadius(): *number*
      
      The radius of the vector arrow shaft relative to the vector length.
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* arrowShaftRelativeRadius(**shaftRelativeRadius**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **shaftRelativeRadius**\ : *number*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.VectorSettings.name

      .. rst-class:: sig-pretty-signature
      
         | *get* name(): *string*
      
      The name of the vector result
      
      **Returns**\ : *string*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* name(**name**\ : *string*\ ): *void*
      
      **Parameters**
      
      
         **name**\ : *string*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.usg.VectorSettings.scaleFactor

      .. rst-class:: sig-pretty-signature
      
         | *get* scaleFactor(): *number*
      
      Scaling factor to use on the vector result
      
      **Returns**\ : *number*
      



.. js:method:: cee.usg.VectorSettings.scaleMode

      .. rst-class:: sig-pretty-signature
      
         | *get* scaleMode(): :js:data:`ScaleMode <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
      
      **Returns**\ : :js:data:`ScaleMode <cee.usg.ScaleMode>`
      



.. js:method:: cee.usg.VectorSettings.singleVectorColor

      .. rst-class:: sig-pretty-signature
      
         | *get* singleVectorColor(): :js:class:`Color3 <cee.Color3>`
      
      The color of the vector arrows
      
      **Returns**\ : :js:class:`Color3 <cee.Color3>`
      
      .. rst-class:: sig-pretty-signature
      
         | *set* singleVectorColor(**color**\ : :js:class:`Color3 <cee.Color3>`\ ): *void*
      
      **Parameters**
      
      
         **color**\ : :js:class:`Color3 <cee.Color3>`
      
      
      **Returns**\ : *void*
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: cee.usg.VectorSettings.setScaleFactor

      .. rst-class:: sig-pretty-signature
      
         | setScaleFactor(**mode**\ : :js:data:`ScaleMode <cee.usg.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**\ : :js:data:`ScaleMode <cee.usg.ScaleMode>`
      
         **scaleFactor**\ : *number*
      
      
      **Returns**\ : *void*
      




