.. role:: ts-api-decorator

#######################
ParticleModelProperties
#######################

.. js:module:: cee.pt
   :noindex:

.. container:: ts-api-section

   .. js:class:: ParticleModelProperties

      Configuration options for ParticleModel.



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~cee.pt.ParticleModelProperties.debugLogging`
   * :js:attr:`~cee.pt.ParticleModelProperties.decimationFactor`
   * :js:attr:`~cee.pt.ParticleModelProperties.maxCacheMemoryMB`
   * :js:attr:`~cee.pt.ParticleModelProperties.onMetrics`
   * :js:attr:`~cee.pt.ParticleModelProperties.opacity`
   * :js:attr:`~cee.pt.ParticleModelProperties.particleColor`
   * :js:attr:`~cee.pt.ParticleModelProperties.particleSize`
   * :js:attr:`~cee.pt.ParticleModelProperties.preloadFrameCount`
   * :js:attr:`~cee.pt.ParticleModelProperties.scalarMapper`
   * :js:attr:`~cee.pt.ParticleModelProperties.useScalarMapping`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.debugLogging

      :type: boolean :ts-api-decorator:`optional`

      Enable console logging of metrics.

      :default:  .. code-block:: ts     false 



.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.decimationFactor

      :type: number :ts-api-decorator:`optional`

      Server-side decimation factor in [0.01, 1.0].

      :default:  .. code-block:: ts     1.0 (all particles) 



.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.maxCacheMemoryMB

      :type: number :ts-api-decorator:`optional`

      Max decoded-frame cache size in MB. LRU eviction when exceeded.

      :default:  .. code-block:: ts     2048 



.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.onMetrics

      :type: function :ts-api-decorator:`optional`

      Callback for per-frame performance metrics.


      .. js:function:: onMetrics( metrics)
         :noindex:

         :param metrics: None
         :type metrics: FrameMetrics


         :rtype: void





.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.opacity

      :type: number :ts-api-decorator:`optional`

      Opacity of the particles. 0 = fully transparent, 1 = fully opaque.

      :default:  .. code-block:: ts     1.0 



.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.particleColor

      :type: Color3 :ts-api-decorator:`optional`

      Solid color when useScalarMapping is false.

      :default:  .. code-block:: ts     white (1,1,1) 



.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.particleSize

      :type: number :ts-api-decorator:`optional`

      Point size for GL_POINTS rendering.

      :default:  .. code-block:: ts     1.0 



.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.preloadFrameCount

      :type: number :ts-api-decorator:`optional`

      Frames to preload ahead of the current frame. 0 disables preloading.

      :default:  .. code-block:: ts     100 



.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.scalarMapper

      :type: ScalarMapper :ts-api-decorator:`optional`

      Scalar mapper for color mapping.



.. container:: ts-api-section

   .. js:attribute:: ParticleModelProperties.useScalarMapping

      :type: boolean :ts-api-decorator:`optional`

      Whether to use scalar mapping for colors.

      :default:  .. code-block:: ts     false 



