.. role:: ts-api-decorator

#################
PartDisplacements
#################

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

.. container:: ts-api-section

   .. js:class:: PartDisplacements

      Displacement result for one part.

      The values stored are displacements or offsets to the geometry part nodes.

      The PartDisplacements class is immutable.



.. container:: api-index-section

   .. rubric:: Constructors

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

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



.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.usg.PartDisplacements.displacementArray`





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

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

.. container:: ts-api-section

   .. js:function:: PartDisplacements.constructor( displacementsArr)

      :param displacementsArr: None
      :type displacementsArr: ArrayLike <number>


      Create a displacement result for one part/mesh

      The array must contain x,y,z values for each node in the mesh, and have the length of 3*mesh.nodeCount

      Note that the displacementsArr should contain displacements relative to the mesh node, and not
      new node coordinates.


      :rtype: PartDisplacements



Accessors
=========

.. container:: ts-api-section

   .. js:function:: PartDisplacements.displacementArray()



      The readonly array containing the displacements defined in this object


      :rtype: ArrayLike <number>



