CNEdEditorBackdrop VectorField

From PopcornFX
Jump to: navigation, search

VectorField backdrop Last update: v1.11.0 - Main page : Editor backdrops Editor backdrops

New v1.13.0 This backdrop inserts a vector-field source in the scene, that can be bound to any Turbulence sampler Turbulence attribute-sampler.


VectorField backdrop Node properties

Field name Default value Description
VectorField backdrop 3D Backdrops
AttachToSocket <empty> Parent socket name to which the backdrop should be attached. (Experimental, reserved for future use)
Position { 0, 0, 0 } Backdrop position
EulerOrientation { 0, 0, 0 } Backdrop orientation angles in radians
UniformScale 1.0 Backdrop scale
ApplyScaleToChilds false If enabled, will scale all the child backdrops by 'UniformScale'
VectorField backdrop DataSource
VectorFieldResource <empty> Path to the file containing the vector-field (.fga)
VectorField backdrop Geometry
GlobalScale 1.0 Overall vector-field scale, scales the Strength property
Strength 1.0 Vector-field strength, higher values produce larger forces
WrapSide true If set, the vector-field will wrap/repeat on its side axis, otherwise, it will be clamped
WrapUp true If set, the vector-field will wrap/repeat on its up axis, otherwise, it will be clamped
WrapForward true If set, the vector-field will wrap/repeat on its forward axis, otherwise, it will be clamped
WrapTime true If set, the vector-field will wrap/repeat on its time axis, otherwise, it will be clamped
Filtering Trilinear Filtering mode to be used when sampling
  • Point : Fastest interpolator. lowest quality. No filtering / interpolation
  • Trilinear : Interpolates between the 8 neighboring cells around the sampling point in 3D space
  • Quadrilinear : Interpolates between the 16 neighboring cells around the sampling point in 4D space
VectorField backdrop Rendering
DepthTest true If enabled, the debug gizmo with not display behind opaque geometry (other backdrops, or opaque mesh particles)
ShowBounds true If enabled, the vector field's bbox will be displayed
BoundsColor { 1, 1, 1, 1 } Color of the bbox
ShowVectors true If enabled, the vector field's vectors will be displayed
VectorScale 0.1 Scale of the vectors
VectorSliceRatio { 1, 1, 1 } Scale applied to thevector field's bbox display that defines the region where debug vectors should be displayed
VectorSliceOffset { 0, 0, 0, 0 } Offset applied to the display box region
VectorSliceMin { -1, -1, -1 } Display box region min
VectorSliceMax { 1, 1, 1 } Display box region max
VectorField backdrop properties


VectorField backdrop Resource files

The 'VectorFieldResource' property of the backdrop expects a path to a .FGA file containing a vector-field.
You can create those files using a tool such as VectorayGen, or custom scripts from your favorite software packages.
This is the same format as used in UE4.


The editor and AssetBaker will import those FGA files an create a smaller, runtime-optimized .pkvf file, that will be efficient to load and sample.