field

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

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

applyPerVertex, attenuation, deltaTime, falloffCurve, falloffCurve_FloatValue, falloffCurve_Interp, falloffCurve_Position, inputData, inputForce, inputMass, inputPPData, inputPositions, inputVelocities, magnitude, maxDistance, outputForce, ownerPPData, sectionRadius, useMaxDistance, volumeExclusion, volumeOffset, volumeOffsetX, volumeOffsetY, volumeOffsetZ, volumeShape, volumeSweep

Long name (short name)	Type	Default	Flags
magnitude (mag)	double	1.0
field magnitude
attenuation (att)	double	0.0
field attenuation
maxDistance (max)	distance (double)	-1.0cm
field max distance
applyPerVertex (apv)	bool	false
apply per vertex (true) or from centroid (false)
useMaxDistance (umd)	bool	false
use max distance value (if true) or infinite distance (if false)
inputData (ind)	compound	n/a
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 Input position array
inputVelocities (inv) vectorArray empty Input velocity array
inputMass (inm) doubleArray empty Input mass array
deltaTime (dt) time 0film 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
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
Force data output to dynamic nodes. The entries in this output array match the input entries in inputPositions et al.
volumeShape (vol)	enum	0
Indicates the shape of volume the field will use. If set to None, volume controls are disabled.
volumeExclusion (vex)	bool	false
Indicates that the field should be apply outside the volume.
volumeOffset (vfo)	double3
offset of the field from the volume.
volumeOffsetX (vox) distance (double) 0.0cm X-component of volume field offset.
volumeOffsetY (voy) distance (double) 0.0cm Y-component of volume field offset.
volumeOffsetZ (voz) distance (double) 0.0cm Z-component of volume field offset.
sectionRadius (tsr)	distance (double)	0.5cm
Applies to torus volumes only. The radius of a section of the torus.
volumeSweep (vsw)	angle (double)	360.0deg
Sweep of the volume sphere, cone, cylinder and torus.
inputPPData (ppda)	genericArray	empty
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
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
Define the falloff curve to use with maxDistance
falloffCurve_Position (fcp) float 0.0 Position of ramp value on normalized 0-1 scale
falloffCurve_FloatValue (fcfv) float 0.0 Ramp value at the sibling position
falloffCurve_Interp (fci) enum 0 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.