Carbon Collider¶
Description¶
This node defines a Collider simulation object, its import geometry, and the Collider parameters.
A Collider is a kinematic object, animated or not, that can be used in the simulation as an immovable object of infinite mass.
Attach this node to a merge node together with a Carbon Cloth node, then the merge node to a Carbon Simulation to form a simple simulation scenario.
An animated Carbon Collider.
Parameters¶
Activation activation
Enable this object. Use 0 to disable, any other value to enable.
Geometry¶
Animated Geometry geometryAnimated
Enable animated parameters for this section by evaluating and updating the values at every frame.
SOP Path soppath
The path to the collision geometry. Can be either a Geometry node object or a SOP node.
Primitive Group primgroup
Primitive group of the geometry that determines which primitive set goes into the collider shape. The whole geometry is used by default when this is left empty.
Note
Cannot be used in combination with Face Group.
Collision Properties¶
Face Group groupA
Face group defining the collision geometry.
Note
- This parameter is optional. If left empty, all faces are used for the collision geometry.
- Cannot be used in combination with Primitive Group.
Inner Fatness innerFatness
Collider’s surface inner volume thickness, in scene units.
See also
Outer Fatness outerFatness
Collider’s surface outer volume thickness, in scene units.
See also
Filtering Gap filteringGap
Collision analysis/filtering gap. Inactive when set to 0.
- The collision analysis is a way to visualize the interpenetrations of an animated collider across time.
- The collision filtering allows weakening of the cloth collisions to avoid layers of cloths getting pinched between two parts of an animated collider or between two colliders.
Setting this to a positive value will enable both the collision analysis and the collision filtering.
The gap value specifies the distance threshold between the two colliders which interpenetrations need to be detected.
Note
- The gap doesn’t include the outer fatness of the collider, it works in addition to it.
- The result of the collision analysis is added to the collision
geometry data as a point attribute named
analysis. It is also viewable using the Collision Analysis Guide Geometry.
See also
Self Analysis selfAnalysis
Enable self collision analysis for this collider.
See also
Collision Material¶
Animated Material materialAnimated
Enable animated parameters for this section by evaluating and updating the values at every frame.
Note
It’s good practice to leave this toggled off when not using
animated parameters because it impacts performance.
Static Friction staticFriction
Collider’s static friction, greater than or equal to 0 and greater than or equal to Dynamic Friction.
See also
Dynamic Friction dynamicFriction
Collider’s dynamic friction, greater than or equal to 0 and smaller than or equal to Static Friction.
See also
Restitution restitution
Collider’s restitution, between 0 and 1. Used during Carbon Rigid Body collisions where the resulting collision energy is modulated by the product of each object’s restitution.
Parameter File¶
Use Parameter File fileOverride
Replace parameter values by expressions fetching the values from the loaded parameter file. Parameter values from the exclusion filter are left unchanged.
File Name fileName
Json file path to save this node’s current parameters to, and load the parameter file from.
Save save
Save this node’s current parameters to the specified file.
Load load
Load or reload the specified parameter file. As the overriding expressions always fetch values from the last loaded parameter file, and not from the file itself, use this button to refresh the loaded current parameter file with the values on disk.
Reload Every Time The Node Is Loaded reload
Automatically reload the parameter file when the scene is loaded. If the specified file cannot be found then the overriding expressions will use the values of the last loaded parameter file instead.
Exclusion Filter exclusionFilter
The exclusion filter allows to select which of the parameters are not to be replaced by the overriding expressions, therefore keeping their original values while all other parameters will evaluate with the values set from the last loaded parameter file.
Guide Geometry¶
Open Edges
Displays the shape edges that are open (edges with a single face attached) or non-manifold (edges with more than two faces attached).
Open Edges colorOpenEdgesr colorOpenEdgesg
colorOpenEdgesb
Color used to draw all open edges.
Non-Manifold edges colorOpenEdgesr colorOpenEdgesg
colorOpenEdgesb
Color used to draw all non-manifold edges.
Fatness Check
Visualize the Inter Fatness (the largest allowed self collision fatness set by the topology) in relation to the object’s Outer Fatness.
See also
Fatness Valid Edges colorValidEdgesr colorValidEdgesg
colorValidEdgesb
Color used to draw all points with Inter Fatness bigger than the shape’s Outer Fatness. These points will use the given Outer Fatness for self collision.
Bad Compressed Edges colorFatCompressedEdgesr
colorCompressedFatEdgesg colorFatCompressedEdgesb
Color used to draw all points with Inter Fatness smaller than the shape’s Outer Fatness but still bigger than half of the shape’s Outer Fatness. These points won’t be able to use the given Outer Fatness for self collision and use the Inter Fatness value instead.
Fatness Invalid Edges colorFatEdgesr colorFatEdgesg
colorFatEdgesb
Color used to draw all points with Inter Fatness smaller than half of the shape’s Outer Fatness. These points won’t be able to use the given Outer Fatness for self collision and use the Inter Fatness value instead.
Double Sided
Visualize the geometry with two distinctive colors per triangle side.
Front colorFrontr colorFrontg colorFrontb
Color used to draw the front facing side.
Back colorBackr colorBackg colorBackb
Color used to draw the back facing side.
Collision Analysis
Visualize the results of the collision analysis run on this collider.
See also
Colliding Faces Acc colorCollidingAccr colorCollidingAccg
colorCollidingAccb
Color used to draw all faces that have self-collided within the specified Filtering Gap up to this point in the animation.
Colliding Faces Frame colorCollidingFramer
colorCollidingFrameg colorCollidingFrameb
Color used to draw all faces that have self-collided within the specified Filtering Gap during the last frame.
Offset offsetColliding
The offset from the geometry surface at which the collision analysis results are drawn.
Update Offset From Collision Properties offsetCollidingButton
Update the Offset from the collision properties. Copies the value of Outer Fatness to Offset.
Examples¶
$SIMCARBONTOOL_PATH/documentation/_downloads/collider.hip
$SIMCARBONTOOL_PATH/documentation/_downloads/collider_sop.hip