Share

liquid_scope

Displays diagnostics for the liquid output of simulate_liquid

Inputs

liquid

The liquid output from simulate_liquid

Levelset Display

show_liquid_levelset

Show the liquid levelset used internally in the solver to represent the surface of the liquid.

show_collider_levelset

Show the combined collider levelset used internally in the solver to represent the colliders.

Point Shape

shape

The shape of the diagnostic points.

point_size_scale

Scaling to apply to the point size.

Point Color

coloring_mode

  • "Color" - This mode uses the default color.
  • "ColoredProperty" - This mode colors the points by multiplying the coloring_property with the default color. If the coloring_property is a scalar, then this option becomes a uniform scaling of color. Negative values are not clamped or modified. If the coloring_property is a vector, per-component multiplication with the default color is performed; e.g. the x-component scales red, the y-component scales blue, and so on.
  • "ColoredPropertyInvertNeg" - This mode is identical to "ColoredProperty" with the following caveats: If the coloring_property is a scalar value, and it is negative, the resulting color will be the result of scaling 1-color by the absolute value of the coloring_property. Also note that vector-valued properties will be converted to scalars by taking their magnitude.
  • "ColoredPropertyMagnitude" - This option takes the magnitude of the coloring_property maps it through the magnitude_fcurve, clamps it between 0 and 1 and then uses to blend the between the different magnitude_color. If the coloring_property is already a scalar, then the absolute value is used.
  • "Property" - This mode simply colors the points by directly mapping the contents of coloring_property to RGB. If the coloring_property is not a vector, then a greyscale mapping is done.
  • "NormalVector" - This mode uses the data mapped to RGB, but the vectors are normalized and remapped to a 0-1 range.
  • "Heatmap" - This mode takes the magnitude of the coloring_property and uses three fcurves to map the result into R, G and B.
  • "Palette" - This mode is designed for integer and bool properties. It uses the coloring_property to map into a fixed palette of colors.

coloring_property

Property used to color the diagnostic points. See coloring_mode for the specifics.

color

The default color for the points.

Colored Property Magnitude

magnitude_start

Lower bound of the coloring_property ahead of magnitude_fcurve

magnitude_end

Upper bound of the coloring_property ahead of magnitude_fcurve

magnitude_fcurve

If the coloring_mode is set to "ColoredPropertyMagnitude", map the magnitude with this fcurve before blending between the different magnitude_color

magnitude_color0

The color used for values of the magnitude_fcurve that are less than or equal 0, it will be blended with the neighboring colors.

magnitude_color1

The color used for values of the magnitude_fcurve that are equal to 0.25, it will be linearly blended with the neighboring colors.

magnitude_color2

The color used for values of the magnitude_fcurve that are equal to 0.5, it will be linearly blended with the neighboring colors.

magnitude_color3

The color used for values of the magnitude_fcurve that are equal to 0.75, it will be linearly blended with the neighboring colors.

magnitude_color4

The color used for values of the magnitude_fcurve that are greater or equal to 1, it will be linearly blended with the neighboring colors.

Heat Map

heatmap_R

The fcurve used for the red component of the color, when the coloring_mode is "Heatmap".

heatmap_G

The fcurve used for the green component of the color, when the coloring_mode is "Heatmap".

heatmap_B

The fcurve used for the blue component of the color, when the coloring_mode is "Heatmap".

Velocity Arrows

show_velocities

Whether to draw the velocity arrows.

arrow_size_scale

Scaling to apply to the velocity arrows.

Draw Fraction

draw_fraction

The diagnostic will randomly sample this proportion of the points to display.

seed

The seed to use for the random sampling.

point_bounds

The points will be limited to the bounding box of this geometry.

Outputs

diagnostic_geo

The diagnostic visualization geometry used for the built-in diagnostics (which are used in the diagnostic terminal).

Was this information helpful?