
####################
DisplacementSettings
####################

.. js:class:: cee.usg.DisplacementSettings

   Settings for the displacement results in one model.
   
   These settings apply to all states in the model.
   
   You can get the settings for the displacements in an usg model with the :js:func:`UnstructGridModel.displacementSettings <cee.usg.UnstructGridModel.displacementSettings>` property.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.usg.DisplacementSettings.constructor`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.usg.DisplacementSettings.scaleFactor`
   
   



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

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


.. js:method:: cee.usg.DisplacementSettings.constructor

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



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

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


.. js:method:: cee.usg.DisplacementSettings.scaleFactor

      .. rst-class:: sig-pretty-signature
      
         | *get* scaleFactor(): *number*
      
      The displacement scaling factor
      
      This factor will be multiplied with the x,y,z component of the displacement result before added to the position of the geometry node.
      
      currentNode = geometry_node + scaleFactor\*displacement_result
      
      **Returns**\ : *number*
      
      .. rst-class:: sig-pretty-signature
      
         | *set* scaleFactor(**scaleFactor**\ : *number*\ ): *void*
      
      **Parameters**
      
      
         **scaleFactor**\ : *number*
      
      
      **Returns**\ : *void*
      




