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

.. js:class:: cee.usg.PartDisplacements

   Displacement result for one part.
   
   The values stored are displacements or offsets to the geometry part nodes.
   
   The PartDisplacements class is immutable.
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.usg.PartDisplacements.constructor`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~cee.usg.PartDisplacements.displacementArray`
   
   



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

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


.. js:method:: cee.usg.PartDisplacements.constructor

      .. rst-class:: sig-pretty-signature
      
         | PartDisplacements(**displacementsArr**\ : *ArrayLike*\ ): :js:class:`PartDisplacements <cee.usg.PartDisplacements>`
      
      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.
      
      **Parameters**
      
      
         **displacementsArr**\ : *ArrayLike*
      
      
      **Returns**\ : :js:class:`PartDisplacements <cee.usg.PartDisplacements>`
      



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

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


.. js:method:: cee.usg.PartDisplacements.displacementArray

      .. rst-class:: sig-pretty-signature
      
         | *get* displacementArray(): *ArrayLike*
      
      The readonly array containing the displacements defined in this object
      
      **Returns**\ : *ArrayLike*
      




