Go to: Related nodes. Attributes.

The field node is a base class node for all fields. It includes the attributes which are common to all the fields, such as magnitude. Each derived class provides the machinery to compute its particular field force from these attributes.

This node is abstract

Node name Parents MFn type Compatible function sets
field dynBase

Related nodes

rigidConstraint, dynBase, airField, turbulenceField, radialField, vortexField, newtonField, volumeAxisField, dragField, uniformField, gravityField, pointEmitter, particle, rigidBody, geoConnectable, spring

Attributes (38)

applyPerVertex, attenuation, axialMagnitude, axialMagnitude_FloatValue, axialMagnitude_Interp, axialMagnitude_Position, curveRadius, curveRadius_FloatValue, curveRadius_Interp, curveRadius_Position, deltaTime, falloffCurve, falloffCurve_FloatValue, falloffCurve_Interp, falloffCurve_Position, inputCurve, inputData, inputForce, inputMass, inputPPData, inputPositions, inputVelocities, magnitude, maxDistance, outputForce, ownerPPData, sectionRadius, trapEnds, trapInside, trapRadius, useMaxDistance, volumeExclusion, volumeOffset, volumeOffsetX, volumeOffsetY, volumeOffsetZ, volumeShape, volumeSweep

Long name (short name) Type Default Flags
magnitude (mag) double 1.0 outputinputconnectablestorablekeyable
field magnitude
attenuation (att) double 0.0 outputinputconnectablestorablekeyable
field attenuation
maxDistance (max) distance (double) -1.0cm outputinputconnectablestorablekeyable
field max distance
applyPerVertex (apv) bool false outputinputconnectablestorablekeyable
apply per vertex (true) or from centroid (false)
useMaxDistance (umd) bool false outputinputconnectablestorablekeyable
use max distance value (if true) or infinite distance (if false)
inputData (ind) compound n/a arrayoutputinputconnectable
Data from dynamic nodes for computing new output force. The field gets data from a set of "points" (particles, locations on a rigid body, etc.) and returns a force computed for each point. Arbitrary user-defined nodes can make use of the field as Tint32 as they can give data for a set of points and can interpret the outputs. Nodes using the field should take care to set up their attributes so as not to cause a DG loop.
inputPositions (inp) vectorArray empty outputinputconnectable
Input position array
inputVelocities (inv) vectorArray empty outputinputconnectable
Input velocity array
inputMass (inm) doubleArray empty outputinputconnectable
Input mass array
deltaTime (dt) time 0film outputinputconnectablehidden
Some fields may need deltaTime to compute force. Of the standard nodes, vortex is the only one. User-defined nodes can use this attribute if they wish.
inputForce (inf) vectorArray empty arrayoutputinputconnectable
Force data from dynamic nodes for computing new output force. If an array of forces is supplied here, the field will ADD its force to that array instead of writing it to outputForce. The particle shape uses this to gain some important efficiencies.
outputForce (of) vectorArray empty arrayoutputconnectable
Force data output to dynamic nodes. The entries in this output array match the input entries in inputPositions et al.
volumeShape (vol) enum 0 outputinputconnectablestorablekeyable
Indicates the shape of volume the field will use. If set to None, volume controls are disabled.
volumeExclusion (vex) bool false outputinputconnectablestorablekeyable
Indicates that the field should be apply outside the volume.
trapInside (trin) double 0.0 outputinputconnectablestorablekeyable
This applies a force to keep objects inside the volume.
trapRadius (trra) double 2.0 outputinputconnectablestorablekeyable
This is the local space distance from the volume boundary within which the trapInside force is applied.
trapEnds (ten) bool true outputinputconnectablestorablekeyable
Indicates for volume curves and cylinders if the trap force is also applied along caps or ends.
volumeOffset (vfo) double3 outputinputconnectablestorable
offset of the field from the volume.
volumeOffsetX (vox) distance (double) 0.0cm outputinputconnectablestorablekeyable
X-component of volume field offset.
volumeOffsetY (voy) distance (double) 0.0cm outputinputconnectablestorablekeyable
Y-component of volume field offset.
volumeOffsetZ (voz) distance (double) 0.0cm outputinputconnectablestorablekeyable
Z-component of volume field offset.
sectionRadius (tsr) distance (double) 0.5cm outputinputconnectablestorablekeyable
Applies to torus volumes only. The radius of a section of the torus.
volumeSweep (vsw) angle (double) 360.0deg outputinputconnectablestorablekeyable
Sweep of the volume sphere, cone, cylinder and torus.
inputPPData (ppda) genericArray empty arrayoutputinputconnectablehidden
This contains a list of arrays and each array stores the per particle inforamtion of a particular attribute that is used to drive this field
ownerPPData (oppd) genericArray empty outputinputconnectablehidden
This contains a list of arrays and each array stores the per particle inforamtion of a particular attribute that is used to drive this field
falloffCurve (fc) compound n/a arrayoutputinputconnectablestorablekeyable
Define the falloff curve to use with maxDistance
falloffCurve_Position (fcp) float 0.0 outputinputconnectablestorablekeyable
Position of ramp value on normalized 0-1 scale
falloffCurve_FloatValue (fcfv) float 0.0 outputinputconnectablestorablekeyable
Ramp value at the sibling position
falloffCurve_Interp (fci) enum 0 outputinputconnectablestorablekeyable
Ramp Interpolation controls the way the intermediate values are calculated. The values are:
None: No interpolation is done; the different colors just show up as different bands in the final texture. Linear: The values are interpolated linearly in RGB color space. Smooth: The values are interpolated along a bell curve, so that each color on the ramp dominates the region around it, then blends quickly to the next color. Spline: The values are interpolated with a spline curve, taking neighboring indices into account for greater smoothness.
axialMagnitude (amag) compound n/a arrayoutputinputconnectablestorablekeyable
Scale the field magnitude along the volume axis. For a curve volume shape the left would represent the magnitude at the base of the nurbs curve and right would be the magnitude at the tip. For a volume cylinder left to right controls the field magnitude from bottom to top.
axialMagnitude_Position (amagp) float 0.0 outputinputconnectablestorablekeyable
Position of ramp value on normalized 0-1 scale
axialMagnitude_FloatValue (amagfv) float 0.0 outputinputconnectablestorablekeyable
Ramp value at the sibling position
axialMagnitude_Interp (amagi) enum 0 outputinputconnectablestorablekeyable
Ramp Interpolation controls the way the intermediate values are calculated. The values are:
None: No interpolation is done; the different colors just show up as different bands in the final texture. Linear: The values are interpolated linearly in RGB color space. Smooth: The values are interpolated along a bell curve, so that each color on the ramp dominates the region around it, then blends quickly to the next color. Spline: The values are interpolated with a spline curve, taking neighboring indices into account for greater smoothness.
curveRadius (crad) compound n/a arrayoutputinputconnectablestorablekeyable
Scale the extent of the volume along the curve. One must use the curve volume shape and also have a curve node attached to the field to use this. The radius along the curve at a given point is defined by the SectionRadius multiplied by the CurveRadius value for that point. The left of the ramp represents the start of the curve (param = 0) and the right is the end of the curve.
curveRadius_Position (cradp) float 0.0 outputinputconnectablestorablekeyable
Position of ramp value on normalized 0-1 scale
curveRadius_FloatValue (cradfv) float 0.0 outputinputconnectablestorablekeyable
Ramp value at the sibling position
curveRadius_Interp (cradi) enum 0 outputinputconnectablestorablekeyable
Ramp Interpolation controls the way the intermediate values are calculated. The values are:
None: No interpolation is done; the different colors just show up as different bands in the final texture. Linear: The values are interpolated linearly in RGB color space. Smooth: The values are interpolated along a bell curve, so that each color on the ramp dominates the region around it, then blends quickly to the next color. Spline: The values are interpolated with a spline curve, taking neighboring indices into account for greater smoothness.
inputCurve (icv) nurbsCurve NULL outputinputconnectable
Input curve shape to use for curve based fields