ParticleModelProperties

class cee.pt.ParticleModelProperties()

Configuration options for ParticleModel.

Properties

cee.pt.ParticleModelProperties.debugLogging

optional

debugLogging: boolean

Enable console logging of metrics.

Default

```ts false ```

cee.pt.ParticleModelProperties.decimationFactor

optional

decimationFactor: number

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

Default

```ts 1.0 (all particles) ```

cee.pt.ParticleModelProperties.maxCacheMemoryMB

optional

maxCacheMemoryMB: number

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

Default

```ts 2048 ```

cee.pt.ParticleModelProperties.onMetrics

optional

onMetrics: (metrics: FrameMetrics) => void

Callback for per-frame performance metrics.

cee.pt.ParticleModelProperties.opacity

optional

opacity: number

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

Default

```ts 1.0 ```

cee.pt.ParticleModelProperties.particleColor

optional

particleColor: Color3

Solid color when useScalarMapping is false.

Default

```ts white (1,1,1) ```

cee.pt.ParticleModelProperties.particleSize

optional

particleSize: number

Point size for GL_POINTS rendering.

Default

```ts 1.0 ```

cee.pt.ParticleModelProperties.preloadFrameCount

optional

preloadFrameCount: number

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

Default

```ts 100 ```

cee.pt.ParticleModelProperties.scalarMapper

optional

scalarMapper: ScalarMapper

Scalar mapper for color mapping.

cee.pt.ParticleModelProperties.useScalarMapping

optional

useScalarMapping: boolean

Whether to use scalar mapping for colors.

Default

```ts false ```