This interface is built to handle number distribution for numbers (1d), points (2d) and vectors (3d). The base type the Distribution is using will have a direct impact on the way the numbers will clamp, generate or spread. Mostly use internally by ParticleNetwork to handle the multitude of ParticleModifier data; the distribution API can be use inside your application to handle dynamic numbers and more.

NumberDistribution

Handle the distribution of a single float value.

Static Variables

Name	Description
`immutable`	Access the NumberImmutable properties.
Declaration NumberImmutable *immutable Note Return `nil` if the DistributionType is not `kImmutable`.
`random`	Access the NumberRandom properties.
Declaration NumberRandom *random Note Return `nil` if the DistributionType is not `kRandom`.
`uniform`	Access the NumberUniform properties.
Declaration NumberUniform *uniform Note Return `nil` if the DistributionType is not `kUniform`.
`interpolate`	Access the NumberInterpolate properties.
Declaration NumberInterpolate *interpolate Note Return `nil` if the DistributionType is not `kInterpolate`.
`driver`	Access the NumberDriver properties.
Declaration NumberDriver *driver Note Return `nil` if the DistributionType is not `kDriver`.

NumberImmutable

Properties of a single immutable value.

Variables

Name Description

constant Constant value.

Declaration

float constant

NumberRandom

Properties of a pseudo-random single value.

Variables

Name	Description
`min`	The lower edge used in the pseudo-random number generation.
Declaration float min
`max`	The upper edge used in the pseudo-random number generation.
Declaration float max

NumberUniform

Properties of a single uniform distribution.

Static Variables

Name	Description
`curve_min`	Curve that controls the minimum allowed value.
Declaration Curve *curve_min
`curve_max`	Curve that controls the maximum allowed value.
Declaration Curve *curve_max

Variables

Name	Description
`cycle_mode_min`	Specify the CycleMode to use for the minimum Curve.
Declaration CycleMode cycle_mode_min
`color_min`	A color to visually identify the `curve_min` inside the Molecules Editor curve area.
Declaration vec4 color_min
`cycle_mode_max`	Specify the CycleMode to use for the maximum Curve.
Declaration CycleMode cycle_mode_max
`color_max`	A color to visually identify the `curve_max` inside the Molecules Editor curve area.
Declaration vec4 color_max

NumberInterpolate

Settings of a linear uni-dimensional value interpolation.

Variables

Name	Description
`from`	The starting point of the interpolation.
Declaration float from
`to`	The end point of the interpolation.
Declaration float to

NumberDriver

Access the related properties to control a driver distribution Curve for a single value.

Static Variables

Name Description

curve Internal Curve used by the NumberDriver to distribute values over time.

Declaration

Curve *curve

Variables

Name	Description
`cycle_mode`	CycleMode of the driver Curve.
Declaration CycleMode cycle_mode
`color`	Color to visually identify the NumberDriver Curve inside the Molecules Editor curve area.
Declaration vec4 color

PointDistribution

Handle the distribution of a two float values (a point).

Static Variables

Name	Description
`immutable`	Access the PointImmutable properties.
Declaration PointImmutable *immutable Note Return `nil` if the DistributionType is not `kImmutable`.
`random`	Access the PointRandom properties.
Declaration PointRandom *random Note Return `nil` if the DistributionType is not `kRandom`.
`uniform`	Access the PointUniform properties.
Declaration PointUniform *uniform Note Return `nil` if the DistributionType is not `kUniform`.
`interpolate`	Access the PointInterpolate properties.
Declaration PointInterpolate *interpolate Note Return `nil` if the DistributionType is not `kInterpolate`.
`driver`	Access the PointDriver properties.
Declaration PointDriver *driver Note Return `nil` if the DistributionType is not `kDriver`.

Variables

Name Description

proportional Force the first component X to be assigned to Y.

Declaration

bool proportional

PointImmutable

Properties of a point immutable value.

Variables

Name Description

constant Constant value.

Declaration

vec2 constant

PointRandom

Properties of a pseudo-random point value.

Variables

Name	Description
`min`	The lower edge used in the pseudo-random point generation.
Declaration vec2 min
`max`	The upper edge used in the pseudo-random point generation.
Declaration vec2 max

PointUniform

Properties of a point uniform distribution.

Static Variables

Name	Description
`curve_min_x`	Curve that controls the minimum `X` value.
Declaration Curve *curve_min_x
`curve_min_y`	Curve that controls the maximum `Y` value.
Declaration Curve *curve_min_y
`curve_max_x`	Curve that controls the maximum `X` value.
Declaration Curve *curve_max_x
`curve_max_y`	Curve that controls the maximum `Y` value.
Declaration Curve *curve_max_y

Variables

Name	Description
`cycle_mode_min_x`	Specify the CycleMode to use for the the min. `X` Curve.
Declaration CycleMode cycle_mode_min_x
`cycle_mode_min_y`	Specify the CycleMode to use for the the min. `Y` Curve.
Declaration CycleMode cycle_mode_min_y
`color_min_x`	A color to visually identify the `curve_min_x` inside the Molecules Editor curve area.
Declaration vec4 color_min_x
`color_min_y`	A color to visually identify the `curve_min_y` inside the Molecules Editor curve area.
Declaration vec4 color_min_y
`cycle_mode_max_x`	Specify the CycleMode to use for the max. `X` Curve.
Declaration CycleMode cycle_mode_max_x
`cycle_mode_max_y`	Specify the CycleMode to use for the max. `Y` Curve.
Declaration CycleMode cycle_mode_max_y
`color_max_x`	A color to visually identify the `curve_max_x` inside the Molecules Editor curve area.
Declaration vec4 color_max_x
`color_max_y`	A color to visually identify the `curve_max_y` inside the Molecules Editor curve area.
Declaration vec4 color_max_y

PointInterpolate

Settings of a linear two-dimensional value interpolation.

Variables

Name	Description
`from`	The start value of the interpolation.
Declaration vec2 from
`to`	The end value of the interpolation.
Declaration vec2 to

PointDriver

Access the related properties to control a driver distribution Curve for a two-dimensional value.

Static Variables

Name	Description
`curve_x`	Internal Curve used by the PointDriver to distribute of the `X` value over time.
Declaration Curve *curve_x
`curve_y`	Internal Curve used by the PointDriver to distribute of the `Y` value over time.
Declaration Curve *curve_y

Variables

Name	Description
`cycle_mode_x`	CycleMode of the driver `X` Curve.
Declaration CycleMode cycle_mode_x
`color_x`	Color to visually identify the PointDriver `X` Curve inside the Molecules Editor curve area.
Declaration vec4 color_x
`cycle_mode_y`	CycleMode of the driver `Y` Curve.
Declaration CycleMode cycle_mode_y
`color_y`	Color to visually identify the PointDriver `Y` Curve inside the Molecules Editor curve area.
Declaration vec4 color_y

VectorDistribution

Handle the distribution of a three float values (a vector).

Static Variables

Name	Description
`immutable`	Access the VectorImmutable properties.
Declaration VectorImmutable *immutable Note Return `nil` if the DistributionType is not `kImmutable`.
`random`	Access the VectorRandom properties.
Declaration VectorRandom *random Note Return `nil` if the DistributionType is not `kRandom`.
`uniform`	Access the VectorUniform properties.
Declaration VectorUniform *uniform Note Return `nil` if the DistributionType is not `kUniform`.
`interpolate`	Access the VectorInterpolate properties.
Declaration VectorInterpolate *interpolate Note Return `nil` if the DistributionType is not `kInterpolate`.
`driver`	Access the VectorDriver properties.
Declaration VectorDriver *driver Note Return `nil` if the DistributionType is not `kDriver`.

Variables

Name Description

proportional Force the first component X to be assigned to Y and Z.

Declaration

bool proportional

VectorImmutable

Properties of a single vector value.

Variables

Name Description

constant Constant value of the VectorDistribution.

Declaration

vec3 constant

VectorRandom

Properties of an immutable vector value.

Variables

Name	Description
`min`	The lower edge used in the pseudo-random vector generation.
Declaration vec3 min
`max`	The upper edge used in the pseudo-random vector generation.
Declaration vec3 max

VectorUniform

Properties of a vector uniform distribution.

Static Variables

Name	Description
`curve_min_x`	Curve that controls the minimum `X` value.
Declaration Curve *curve_min_x
`curve_min_y`	Curve that controls the maximum `Y` value.
Declaration Curve *curve_min_y
`curve_min_z`	Curve that controls the minimum `Z` value.
Declaration Curve *curve_min_z
`curve_max_x`	Curve that controls the maximum `X` value.
Declaration Curve *curve_max_x
`curve_max_y`	Curve that controls the maximum `Y` value.
Declaration Curve *curve_max_y
`curve_max_z`	Curve that controls the maximum `Z` value.
Declaration Curve *curve_max_z

Variables

Name	Description
`cycle_mode_min_x`	Specify the CycleMode to use for the the min. `X` Curve.
Declaration CycleMode cycle_mode_min_x
`cycle_mode_min_y`	Specify the CycleMode to use for the the min. `Y` Curve.
Declaration CycleMode cycle_mode_min_y
`cycle_mode_min_z`	Specify the CycleMode to use for the the min. `Z` Curve.
Declaration CycleMode cycle_mode_min_z
`color_min_x`	A color to visually identify the `curve_min_x` inside the Molecules Editor curve area.
Declaration vec4 color_min_x
`color_min_y`	A color to visually identify the `curve_min_y` inside the Molecules Editor curve area.
Declaration vec4 color_min_y
`color_min_z`	A color to visually identify the `curve_min_z` inside the Molecules Editor curve area.
Declaration vec4 color_min_z
`cycle_mode_max_x`	Specify the CycleMode to use for the max. `X` Curve.
Declaration CycleMode cycle_mode_max_x
`cycle_mode_max_y`	Specify the CycleMode to use for the max. `Y` Curve.
Declaration CycleMode cycle_mode_max_y
`cycle_mode_max_z`	Specify the CycleMode to use for the max. `Z` Curve.
Declaration CycleMode cycle_mode_max_z
`color_max_x`	A color to visually identify the `curve_max_x` inside the Molecules Editor curve area.
Declaration vec4 color_max_x
`color_max_y`	A color to visually identify the `curve_max_y` inside the Molecules Editor curve area.
Declaration vec4 color_max_y
`color_max_z`	A color to visually identify the `curve_max_z` inside the Molecules Editor curve area.
Declaration vec4 color_max_z

VectorInterpolate

Settings of a linear three-dimensional value interpolation.

Variables

Name	Description
`from`	The start value of the interpolation.
Declaration vec3 from
`to`	The end value of the interpolation.
Declaration vec3 to

VectorDriver

Access the related properties to control a driver distribution Curve for a vector value.

Static Variables

Name	Description
`curve_x`	Internal Curve used by the VectorDriver to distribute of the `X` value over time.
Declaration Curve *curve_x
`curve_y`	Internal Curve used by the VectorDriver to distribute of the `Y` value over time.
Declaration Curve *curve_y
`curve_z`	Internal Curve used by the VectorDriver to distribute of the `Z` value over time.
Declaration Curve *curve_z

Variables

Name	Description
`cycle_mode_x`	CycleMode of the driver `X` Curve.
Declaration CycleMode cycle_mode_x
`color_x`	Color to visually identify the VectorDriver `X` Curve inside the Molecules Editor curve area.
Declaration vec4 color_x
`cycle_mode_y`	CycleMode of the driver `Y` Curve.
Declaration CycleMode cycle_mode_y
`color_y`	Color to visually identify the VectorDriver `Y` Curve inside the Molecules Editor curve area.
Declaration vec4 color_y
`cycle_mode_z`	CycleMode of the driver `Z` Curve.
Declaration CycleMode cycle_mode_z
`color_z`	Color to visually identify the VectorDriver `Z` Curve inside the Molecules Editor curve area.
Declaration vec4 color_z

DistributionType

Various types that can be applied to any sort of number distribution.

kImmutable: Static number.
kRandom: Pseudo-random number between two edges.
kUniform: Min. and max. values are controlled by two curves.
kInterpolate: Linear interpolation between edges.
kDriver: The distribution value is controlled by one or multiple Curve.