Differences

This shows you the differences between two versions of the page.

--- visual3d:documentation:pipeline:file_commands:clear_recalc_pipeline [2024/07/17 15:45] – created sgranger
+++ visual3d:documentation:pipeline:file_commands:clear_recalc_pipeline [2025/07/30 19:31] (current) – wikisysop
@@ Line 1: / Line 1: @@
 ====== Clear Recalc Pipeline ======
-Clears the [[Visual3D:Documentation:Pipeline:General_Information:RECALC_Pipeline|RECALC Pipeline]].
+===== Overview =====
+The **Clear_Recalc_Pipeline** command is used to clear all commands from the RECALC pipeline in Visual3D. The RECALC pipeline is a special list of commands that is executed automatically whenever the Recalc command is run or the RECALC button is clicked in the interface.
+In most cases, the pipeline contains model-based calculations- such as kinematics, kinetics, or custom metrics- that the user wants automatically updated when model changes occur. However, in some workflows (particularly automated or batch operations), the user may want to manually control which commands get executed during a recalculation.
+For more information about the RECALC pipeline, including how to modify it, refer to the [[visual3d:documentation:pipeline:general_information:recalc_pipeline|RECALC Pipeline]] page.
+===== Pipeline Command =====
+The command below is as seen in the Visual3D application. It does not include any parameters.
 <code>
@@ Line 9: / Line 19: @@
 </code>
-\\
+===== Command Parameters =====
+There are no parameters associated with this command. It performs a single action: clearing all commands currently in the RECALC pipeline.
+===== Dialog =====
+This command does not have a dialog version. The interface equivalent is clicking the **Clear Pipeline** button while the Recalc Pipeline tab is selected in the Pipeline Workshop window.
+{{:visual3d:documentation:pipeline:file_commands:clr_recalc_pipeline_u8.png?600|}}
+===== Examples =====
+The following example will go through the use of the Clear_Recalc_Pipeline command in the Visual3D application.
+=== Example 1: Resetting the Recalc Pipeline Before Adding Custom Commands ===
+This example demonstrates how to clear the RECALC pipeline and add new commands manually. This ensures that only the user-defined steps are executed during recalculation.
+Step 1: Clear the current Recalc Pipeline
+<code>
+Clear_Recalc_Pipeline
+;
+</code>
+Step 2: Add a custom computation and run recalc to update the workspace using only the custom command.
+<code>
+Compute_Model_Based_Data
+/RESULT_NAME=Left_Hip_Angle
+! /SUBJECT_TAG=
+/FUNCTION=JOINT_ANGLE|
+/SEGMENT=LTH
+/REFERENCE_SEGMENT=RPV
+! /RESOLUTION_COORDINATE_SYSTEM=
+! /USE_CARDAN_SEQUENCE=FALSE
+! /NORMALIZATION=FALSE
+! /NORMALIZATION_METHOD=
+! /NORMALIZATION_METRIC=
+! /NEGATEX=FALSE
+ !/NEGATEY=FALSE
+! /NEGATEZ=FALSE
+! /AXIS1=X
+! /AXIS2=Y
+! /AXIS3=Z
+!/TREADMILL_DATA=FALSE
+!/TREADMILL_DIRECTION=UNIT_VECTOR(0,1,0)
+!/TREADMILL_SPEED=0.0
+;
+Recalc
+;
+</code>
+----
 [[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]