Go to:
Return value. Related commands. Flags. Examples.
Synopsis
cpForces [flag]
Return value
varies depending on use.
Related commands
cpSolverFlags
createForceWatch, filter, help, listForces, listForces, output, removeForceWatch, watchType
| Long name (short name) | [argument types] | Properties |
|---|
-help
(-h)
| |  |
|
Prints a quick help message.
|
|
-listForces
(-lf)
| solver | |
|
Lists the registered forces on the given solver node.
|
|
-watchType
(-wt)
| typeName | |
|
Currently type name can only be "file". This flag must
be used with the -cfw flag.
|
|
-output
(-o)
| output_file | |
|
When watchType is file, this flag controls where the output
data is sent. By default, output is send to stdout.
|
|
-filter
(-f)
| filter_type | |
|
The filter type can be "condensed" or "raw". In "condensed" mode,
forces are filtered if their value is zero. Also, in a time block,
multiple forces per vertex will be averaged to a single value. Raw
mode is the default filter type and displays all information without
any filtering. This flag is only applicable on creation of the watch.
|
|
-createForceWatch
(-cfw)
| force_name | |
|
Adds a force watch for the current solver. The force name
must exist and should be identical to the name queried using
|
|
-listForces
(-lf)
| flag. Each force can only be watched once | |
|
per-solver. It is invalid to watch a force that has already
watched.
|
|
-removeForceWatch
(-rfw)
| force_name | |
|
Removes a previously added force watch.
|
|
|
Flag can appear in Create mode of command
| 
Flag can appear in Edit mode of command
|
Flag can appear in Query mode of command
| 
Flag can be used more than once in a command
|
Examples
// Create a file force watch on solidContacts that happen in
// the cloth scene. Dump the output to a text file. Print the
// output in condensed mode.
cpForces -wt "file" -o "solidContact.txt" -filter "condensed"
-cfw "solidContact";
// To stop watching solidContacts forces, this will close the file
// created above.
cpForces -rfw "solidContact";