{
  "name": "AddRecordedCameraPerformer",
  "main": {
    "name": "AddRecordedCameraPerformer",
    "namespace": "sofa::gui::component::performer",
    "module": "Sofa.GUI.Component",
    "include": "sofa/gui/component/performer/AddRecordedCameraPerformer.h",
    "doc": "",
    "inherits": [
      "InteractionPerformer"
    ],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "start",
        "return_type": "void",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "execute",
        "return_type": "void",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      }
    ]
  },
  "desc": {
    "description": "The `AddRecordedCameraPerformer` is a component in the SOFA framework, specifically within the `sofa::gui::component::performer` namespace. It inherits from `InteractionPerformer`, making it part of the GUI and interaction system designed for managing camera interactions during simulation runs.\n\nIts primary role is to save the current camera's position and orientation into a `RecordedCamera` object, facilitating navigation through recorded camera paths. This component interacts with other SOFA components like `BaseMouseInteractor` and `RecordedCamera`. The `execute` method is overridden but not implemented, while the `start` method captures the camera state and stores it in the appropriate data fields of `RecordedCamera`.\n\nPractically, this component should be used to record camera movements for later playback or navigation. It does not expose any additional configuration parameters beyond what is inherited from its base class."
  },
  "maths": {
    "maths": "The `AddRecordedCameraPerformer` is a component within the SOFA framework designed for managing camera interactions. It inherits from `InteractionPerformer`, which indicates it is part of the GUI and interaction system. This component's primary role is to record the current position and orientation of the camera during simulation runs, facilitating navigation through recorded camera paths.\n\n### Mathematical and Physical Description:\n\n#### Role in the Simulation Pipeline:\nThe `AddRecordedCameraPerformer` does not contribute directly to the core FEM pipeline (i.e., mass matrix $M$, stiffness matrix $K$, internal force $f_{int}$, residual $R$) nor does it involve constitutive or kinematic laws such as strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc. Instead, its function is auxiliary and concerns the visualization aspect of the simulation.\n\n#### Numerical Methods:\nThe component interacts with the `RecordedCamera` object to save camera positions and orientations in a series of vectors (`d_translationPositions`, `d_translationOrientations`). The method `start()` captures the current state of the camera and appends it to these vectors for later playback or navigation.\n\n#### Implementation Details:\nThe component overrides two methods from its base class `InteractionPerformer`: `start()` and `execute()`. \n- **`start()`**: Captures the current position (`_pos`) and orientation (`_ori`) of the camera, then appends these values to the vectors `d_translationPositions` and `d_translationOrientations`, respectively.\n- **`execute()`**: This method is overridden but not implemented, suggesting it can be extended for additional functionality if needed.\n\n#### Variational Mechanics Framework:\nThe component does not directly contribute to the variational mechanics framework. Instead, its role is in the post-processing and visualization phase of simulations by recording camera movements. \n\n### Conclusion:\nThe `AddRecordedCameraPerformer` is a utility component for capturing and saving camera states during simulation runs, enabling navigation through recorded camera paths. It does not participate in the core numerical or physical aspects of FEM simulations but enhances the usability and visualization capabilities within SOFA."
  },
  "summary": {
    "abstract": "The `AddRecordedCameraPerformer` records the current camera's position and orientation into a `RecordedCamera` object for later playback or navigation during simulation runs.",
    "sheet": "# AddRecordedCameraPerformer\n\n## Overview\n\nThe `AddRecordedCameraPerformer` is a component in the SOFA framework that inherits from `InteractionPerformer`. Its primary role is to record the current position and orientation of the camera into a `RecordedCamera` object, facilitating navigation through recorded camera paths. This component interacts with other SOFA components like `BaseMouseInteractor` and `RecordedCamera`.\n\n## Dependencies and Connections\n\nThe `AddRecordedCameraPerformer` typically requires or exchanges data with:\n- **`BaseMouseInteractor`:** For capturing the current state of the camera during simulation runs.\n- **`RecordedCamera`:** To store the recorded positions and orientations for later playback or navigation."
  }
}