.. role:: clio-const
   :class: clio-flag clio-flag-const


##
pt
##

.. js:module:: cee.pt

   The **pt** sub-module provides a client-side particle simulation model.
   
   .. rubric:: Examples
   
   
   .. code-block:: typescript
   
      const model = new cee.pt.ParticleModel();
      await model.openModel('http://server/api/v1/models/mydata.ptfx');
      await model.setFrame(0);
      // Use model.setFrame(n) to seek - cancels previous inflight requests automatically
      model.closeModel();
   
   
   Index
   =====
   
   .. rubric:: Variables
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.pt.DEFAULT_PARTICLE_MODEL_PROPERTIES`
   
   



.. rst-class:: kind-group kind-classes

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


.. rst-class:: api-xref-list


* :js:class:`~cee.pt.Animation`
* :js:class:`~cee.pt.ParticleModel`

.. rst-class:: kind-group kind-interfaces

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


.. rst-class:: api-xref-list


* :js:class:`~cee.pt.AnimationFrameChangedCallback`
* :js:class:`~cee.pt.DatasetInfo`
* :js:class:`~cee.pt.FrameMetrics`
* :js:class:`~cee.pt.ParticleModelProperties`
* :js:class:`~cee.pt.ScalarFieldUpdate`
* :js:class:`~cee.pt.ScalarRange`
* :js:class:`~cee.pt.ServerErrorHandler`

.. rst-class:: kind-group kind-type-aliases

.. rubric:: Type Aliases
   :class: kind-group-title


.. rst-class:: api-xref-list


* :js:data:`~cee.pt.RequireAllExcept`

.. rst-class:: kind-group kind-variables

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


.. js:data:: cee.pt.DEFAULT_PARTICLE_MODEL_PROPERTIES

      .. rst-class:: clio-flags
      
         :clio-const:`const`
      
      .. rst-class:: sig-pretty-signature
      
         | DEFAULT_PARTICLE_MODEL_PROPERTIES: :js:data:`RequireAllExcept <cee.pt.RequireAllExcept>`\ <:js:class:`ParticleModelProperties <cee.pt.ParticleModelProperties>`\ , (*"scalarMapper"* | *"onMetrics"*\ )>
      
      Default property values.
      



.. toctree::
   :maxdepth: 1
   :hidden:

   ../classes/cee.pt.Animation
   ../classes/cee.pt.ParticleModel
   ../interfaces/cee.pt.AnimationFrameChangedCallback
   ../interfaces/cee.pt.DatasetInfo
   ../interfaces/cee.pt.FrameMetrics
   ../interfaces/cee.pt.ParticleModelProperties
   ../interfaces/cee.pt.ScalarFieldUpdate
   ../interfaces/cee.pt.ScalarRange
   ../interfaces/cee.pt.ServerErrorHandler
   ../types/cee.pt.RequireAllExcept


