rigidBody

Go to: Related nodes. Attributes.

The rigid node contains the attributes for the rigid body. This node controls the active rigid body behavior of a polygonal or nurbs shape. If the object is a nurbs shape the shape is tessellated for collisions. The tessellated shape is then passed to the rigid solver. This node also includes a cache which the user can turn on on a per rigid body basis. This node moniters the mesh/nurbs shape to determine if the shape's surface changes via a scale or some form of deformation. If the shape is changed the surface is re-tessellated and passed to the rigid solver.

Related nodes

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

Attributes (112)

Attribute quick index omitted (too many attributes to show them all).

Long name (short name)	Type	Default	Flags
allowDisconnection (ad)	bool	false
Allows the user to disconnect the connection made by the rigid body to the solver, time node and choice nodes.
spin (sp)	double3	0, 0, 0
The current angular velocity of the rigid body.
spinX (spx) double 0.0 The X component of the current angular velocity.
spinY (spy) double 0.0 The Y component of the current angular velocity.
spinZ (spz) double 0.0 The Z component of the current angular velocity.
initialSpin (is)	double3	0, 0, 0
The initial angular (rotational) velocity of the rigid body in the dynamics simulation.
initialSpinX (isx) angle (double) 0.0deg The X component of the initial angular velocity.
initialSpinY (isy) angle (double) 0.0deg The Y component of the initial angular velocity.
initialSpinZ (isz) angle (double) 0.0deg The Z component of the initial angular velocity
applyForceAt (afa)	enum	1
Determines at what points to apply forces to the rigid body.
autoInit (ai)	bool	true
Turns on and off the auto initialization feature.
bakeSimulationIndex (bsi)	integer	-1
Indicates the choice selection index during a bake simulation.
cacheDirtyArray (cda)	intArray	empty
REMOVE IN POST 2.0 RELEASE.
cachedFrameCount (cfc)	integer	0
The number of cached frames.
centerOfMass (com)	double3	0, 0, 0
For purposes of the dynamic simulation this is the point (in object space) the object naturally should rotate around. For more realistic rotational motion this point should be placed at or near what would be considered the heaviest part of the rigid body.
centerOfMassX (cmx) double 0.0 The X component of the center of mass to rotate around.
centerOfMassY (cmy) double 0.0 The Y component of the center of mass to rotate around.
centerOfMassZ (cmz) double 0.0 The Z component of the center of mass to rotate around.
choice (chc)	integer	0
determine which selection the choice node uses
collisionLayer (cl)	integer	0
Determines which collision layer the rigid body is in. Rigid bodies will only collide with other rigid bodies that are in the same layer. Rigid bodies in collision layer -1 will collide with all other rigid bodies in the scene regardless of their collision layer.
collisionRecords (crc)	genericArray	empty
particle collision force data
collisions (col)	bool	true
Turns collisions off if set false
contactCount (cct)	integer	0
Number of valid contact points.
contactName (cnn)	string	nullptr
index to rigid bodies which are contacting.
contactPosition (cnp)	double3
Array of rigid body contact positions.
contactX (cnx) double 0.0 X contact point
contactY (cny) double 0.0 Y contact point
contactZ (cnz) double 0.0 Z contact point
currentTime (ct)	time	::zero
This holds the value for time.
damping (dp)	double	0.0
Controls how much a rigid body tends to lose velocity. A value of 0 result in no velocity being lost to damping. A value of >0 results in velocity being lost. A value of <0 results in velocity being gained. Use larger values for large bulky rigid bodies and values closer to 0 for small compact rigid bodies.
dataCache (dc)	doubleArray	empty
data cache
debugDraw (dd)	bool	false
Draws the rigid body mesh. Used for debugging only.
dynamicFriction (df)	double	0.2
dynamic friction value of the rigid body.
fieldConnections (fc)	Message	n/a
Obsolete attribute from version 1. Included only for file compatibility. Not otherwise used. To be removed in post version 3 release.
fieldData (fld)	compound	n/a
force data for the field forces.
fieldDataPosition (fdp) vectorArray empty position data for fields.
fieldDataVelocity (fdv) vectorArray empty velocity data for fields.
fieldDataMass (fdm) doubleArray empty mass data for fields.
deltaTime (dt) time ::zero some fields may need deltaTime to compute force (i.e. Vortex).
firstCachedFrame (fcf)	integer	0
The first frame of the cache.
force (for)	double3	0, 0, 0
The current force on the rigid body.
forceX (fx) double 0.0 The X component of the current force on the rigid body.
forceY (fy) double 0.0 The Y component of the current force on the rigid body.
forceZ (fz) double 0.0 The Z component of the current force on the rigid body.
generalForce (gfr)	compound	n/a
generalized for on the rigid body (forces and torques).
outputForce (ofr) vectorArray empty forces on the rigid body calculated from the external and collision forces.
outputTorque (otr) vectorArray empty torques on the rigid body calculated from the external and collision forces.
ignore (ign)	bool	false
The rigid body is ignored in the simulator if true.
impulse (imp)	double3	0, 0, 0
Intended to be used to apply a momentary force (via keyframing of impulse) to the object. Should be zero except during the brief period the force is in effect.
impulseX (imx) double 0.0 The X component of the impulse force.
impulseY (imy) double 0.0 The Y component of the impulse force.
impulseZ (imz) double 0.0 The Z component of the impulse force.
impulsePosition (ipo)	double3	0, 0, 0
This is the position (in object space) at which the impulse force is applied to a rigid body.
impulsePositionX (pix) double 0.0 The X component of the position at which the impulse force is applied.
impulsePositionY (piy) double 0.0 The Y component of the position at which the impulse force is applied.
impulsePositionZ (piz) double 0.0 The Z component of the position at which the impulse force is applied.
inputForce (ifr)	vectorArray	empty
force applied by external factors (fields) on the rigid body.
inputForceType (ift)	bool	false
Type of force (positional/non-positional) connected to rigid body.
inputGeometryCnt (igc)	integer	0
number of geometry shapes connected to this rigid shape.
inputGeometryMsg (igm)	Message	n/a
Connection to geometry shape node.
interpenetrateWith (itw)	Message	n/a
connections to objects which this rigid body is allowed to interpenetrate.
active (act)	bool	true
This determines whether the rigid body is treated as an active rigid body or a passive rigid body.
cacheData (idc)	bool	false
data is in cache flag
isKeyframed (key)	bool	false
set if the rigid body is keyframed.
isKinematic (kin)	bool	false
determines if the rigidBody is keyframed or parented.
isParented (par)	bool	false
set if the rigid body is parented.
lastCachedFrame (lcf)	integer	0
The last frame of the cache.
lastPosition (lp)	double3	0, 0, 0
last position of the rigid body
lastPositionX (lpx) double 0.0 last position x of the rigid body.
lastPositionY (lpy) double 0.0 last position y of the rigid body.
lastPositionZ (lpz) double 0.0 last position z of the rigid body.
lastRotation (lr)	double3	0, 0, 0
last rotation of the rigid body
lastRotationX (lrx) double 0.0 last rotation x of the rigid body.
lastRotationY (lry) double 0.0 last rotation y of the rigid body.
lastRotationZ (lrz) double 0.0 last rotation z of the rigid body.
lastSceneTime (lst)	time	::zero
This is the scene time for the last time the dynamics was evaluated for this rigid node.
lockCenterOfMass (lcm)	bool	false
Locks the center of mass of the rigid body so that it is not automatically recalculated if the object is modified.
mass (mas)	double	1.0
The mass of the rigid body. Use larger values for heavier objects.
initialOrientation (ior)	double3	0, 0, 0
The initial orientation of the rigid body in the dynamics simulation.
initialOrientationX (iox) angle (double) 0.0deg The X component of the initial orientation.
initialOrientationY (ioy) angle (double) 0.0deg The Y component of the initial orientation.
initialOrientationZ (ioz) angle (double) 0.0deg The Z component of the initial orientation.
particleCollision (pc)	bool	false
If this is an active rigid body and you have setup some particles to collide with it, setting this attribute to TRUE will allow the object to move as a result of those particle collisions.
initialPosition (ip)	double3	0, 0, 0
The initial position of the rigid body in the dynamics simulation.
initialPositionX (ipx) double 0.0 The X component of the initial position.
initialPositionY (ipy) double 0.0 The Y component of the initial position.
initialPositionZ (ipz) double 0.0 The Z component of the initial position.
bounciness (b)	double	0.6
Controls how much bounce a rigid body contributes to collisions. Larger values increase bounce. Imagine a ball bouncing up and down on a floor. If both the ball and the floor have a setting of 1.0 the ball will bounce to the same height each time it bounces. If either the ball or the floor is modified to have a value less than 1.0 the height the ball bounces to will diminish each time it bounces. Conversely, if either the ball or the floor had been modified to have a value greater than 1.0 the ball would bounce higher with each bounce.
rigidWorldMatrix (rmx)	matrix	identity
Local transformation matrix. Contains the same information as the matrix attribute on dagNode but it is stored in a format that can be interpolated easily.
runUpCache (rc)	doubleArray	empty
run up and instantaneous data cache.
shapeChanged (sc)	integer	false
Indicates that the shape has changed and needs updating. This is an internal attribute that should not be modified by the user.
solverId (sid)	integer	-1
this is the index into the solver multi attributes.
spinImpulse (sim)	double3	0, 0, 0
Intended to be used to apply a momentary rotational force (via keyframing of spin impulse) to the object. Should be zero except during the brief period the force is in effect.
spinImpulseX (six) double 0.0 The X component of the rotational impulse force.
spinImpulseY (siy) double 0.0 The Y component of the rotational impulse force.
spinImpulseZ (siz) double 0.0 The Z component of the rotational impulse force.
standIn (si)	enum	0
To speed up the dynamics simulation at the expense of less accuracy. Set this to use a simpler shape (such as a sphere or cube) for collisions instead of the actual geometry. A setting of NONE will use the actual geometry.
staticFriction (sf)	double	0.2
static friction value of the rigid body.
tessellationFactor (tes)	integer	200
The tessellation factor for nurbs surfaces.
torque (tor)	double3	0, 0, 0
The current torque on the rigid body.
torqueX (trx) angle (double) 0.0deg The X component of the current torque on the rigid body.
torqueY (try) angle (double) 0.0deg The Y component of the current torque on the rigid body.
torqueZ (trz) angle (double) 0.0deg The Z component of the current torque on the rigid body.
velocity (vel)	double3	0, 0, 0
The current velocity of the rigid body.
velocityX (vx) double 0.0 The X component of the current velocity.
velocityY (vy) double 0.0 The Y component of the current velocity.
velocityZ (vz) double 0.0 The Z component of the current velocity.
initialVelocity (iv)	double3	0, 0, 0
The initial velocity of the rigid body in the dynamics simulation.
initialVelocityX (ivx) double 0.0 The X component of the initial velocity.
initialVelocityY (ivy) double 0.0 The Y component of the initial velocity.
initialVelocityZ (ivz) double 0.0 The Z component of the initial velocity.
volume (vol)	double	0.0
volume of the rigid body.