.. role:: ts-api-decorator

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

.. js:module:: cee.usg
   :noindex:

.. container:: ts-api-section

   .. js:class:: 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 
      ``UnstructGridModel.displacementSettings`` property.



.. container:: api-index-section

   .. rubric:: Constructors

   .. rst-class:: api-index-list-item api-kind-constructor api-parent-kind-class

   * :js:meth:`~cee.usg.DisplacementSettings.constructor`



.. container:: api-index-section

   .. rubric:: Accessors

   .. rst-class:: api-index-list-item api-kind-accessor api-parent-kind-class

   * :js:attr:`~cee.usg.DisplacementSettings.scaleFactor`





------------

Constructors
============

.. container:: ts-api-section

   .. js:function:: DisplacementSettings.constructor()



      :rtype: DisplacementSettings



Accessors
=========

.. container:: ts-api-section

   .. js:function:: DisplacementSettings.scaleFactor()



      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


      :rtype: number

   .. js:function:: DisplacementSettings.scaleFactor( scaleFactor)

      :param scaleFactor: None
      :type scaleFactor: number


      :rtype: void



