.. role:: clio-optional
   :class: clio-flag clio-flag-optional


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

.. js:class:: cee.pt.ParticleModelProperties

   Configuration options for ParticleModel.
   
   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.pt.ParticleModelProperties.debugLogging`
   * :js:data:`~cee.pt.ParticleModelProperties.decimationFactor`
   * :js:data:`~cee.pt.ParticleModelProperties.maxCacheMemoryMB`
   * :js:data:`~cee.pt.ParticleModelProperties.onMetrics`
   * :js:data:`~cee.pt.ParticleModelProperties.opacity`
   * :js:data:`~cee.pt.ParticleModelProperties.particleColor`
   * :js:data:`~cee.pt.ParticleModelProperties.particleSize`
   * :js:data:`~cee.pt.ParticleModelProperties.preloadFrameCount`
   * :js:data:`~cee.pt.ParticleModelProperties.scalarMapper`
   * :js:data:`~cee.pt.ParticleModelProperties.useScalarMapping`
   
   



.. rst-class:: kind-group kind-properties

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


.. js:data:: cee.pt.ParticleModelProperties.debugLogging

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | debugLogging: *boolean*
      
      Enable console logging of metrics.
      
      .. rubric:: Default
      
      
      `````ts
      false
      `````
      



.. js:data:: cee.pt.ParticleModelProperties.decimationFactor

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | decimationFactor: *number*
      
      Server-side decimation factor in [0.01, 1.0].
      
      .. rubric:: Default
      
      
      `````ts
      1.0 (all particles)
      `````
      



.. js:data:: cee.pt.ParticleModelProperties.maxCacheMemoryMB

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | maxCacheMemoryMB: *number*
      
      Max decoded-frame cache size in MB. LRU eviction when exceeded.
      
      .. rubric:: Default
      
      
      `````ts
      2048
      `````
      



.. js:data:: cee.pt.ParticleModelProperties.onMetrics

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | onMetrics: (**metrics**\ : :js:class:`FrameMetrics <cee.pt.FrameMetrics>`\ ) => *void*
      
      Callback for per-frame performance metrics.
      



.. js:data:: cee.pt.ParticleModelProperties.opacity

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | opacity: *number*
      
      Opacity of the particles. 0 = fully transparent, 1 = fully opaque.
      
      .. rubric:: Default
      
      
      `````ts
      1.0
      `````
      



.. js:data:: cee.pt.ParticleModelProperties.particleColor

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | particleColor: :js:class:`Color3 <cee.Color3>`
      
      Solid color when useScalarMapping is false.
      
      .. rubric:: Default
      
      
      `````ts
      white (1,1,1)
      `````
      



.. js:data:: cee.pt.ParticleModelProperties.particleSize

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | particleSize: *number*
      
      Point size for GL_POINTS rendering.
      
      .. rubric:: Default
      
      
      `````ts
      1.0
      `````
      



.. js:data:: cee.pt.ParticleModelProperties.preloadFrameCount

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | preloadFrameCount: *number*
      
      Frames to preload ahead of the current frame. 0 disables preloading.
      
      .. rubric:: Default
      
      
      `````ts
      100
      `````
      



.. js:data:: cee.pt.ParticleModelProperties.scalarMapper

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | scalarMapper: :js:class:`ScalarMapper <cee.ScalarMapper>`
      
      Scalar mapper for color mapping.
      



.. js:data:: cee.pt.ParticleModelProperties.useScalarMapping

      .. rst-class:: clio-flags
      
         :clio-optional:`optional`
      
      .. rst-class:: sig-pretty-signature
      
         | useScalarMapping: *boolean*
      
      Whether to use scalar mapping for colors.
      
      .. rubric:: Default
      
      
      `````ts
      false
      `````
      




