Data Fields

Methods

{
  "name": "MouseButtonSetting",
  "namespace": "sofa::component::setting",
  "module": "Sofa.Component.Setting",
  "include": "sofa/component/setting/MouseButtonSetting.h",
  "doc": "",
  "inherits": [
    "ConfigurationSetting"
  ],
  "templates": [],
  "data_fields": [
    {
      "name": "d_button",
      "type": "sofa::helper::OptionsGroup",
      "xmlname": "button",
      "help": "Mouse button used"
    }
  ],
  "links": [],
  "methods": [
    {
      "name": "getOperationType",
      "return_type": "int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `MouseButtonSetting` component in the SOFA framework is part of the Sofa.Component.Setting module and inherits from `ConfigurationSetting`. It is designed to configure mouse button settings within a simulation scene, allowing users to specify which mouse buttons are used for specific interactions or operations. The primary data field it manages is `d_button`, which uses an `OptionsGroup` type to define the mouse button (Left, Middle, Right). This component plays a role in defining user interaction parameters and can be utilized in scenarios where precise control over mouse inputs is required.",
  "maths": "The `MouseButtonSetting` component in the SOFA framework does not contribute to any governing equations, constitutive laws, kinematic laws, or numerical methods related to FEM simulation. It is a configuration setting that allows users to specify which mouse buttons are used for specific interactions within the simulation environment.\n\n- **Governing Equations**: None.\n- **Constitutive Laws**: None.\n- **Kinematic Laws**: None.\n- **Numerical Methods / Discretization Choices**: None.\n- **Role in FEM Pipeline**: This component does not play a role in the global FEM pipeline. It is purely for configuring user interaction parameters, such as specifying which mouse button (Left, Middle, Right) is used for certain operations within the simulation scene.\n\nIn summary, `MouseButtonSetting` is a pure configuration and user input handling component and has no mathematical or physical content related to computational mechanics.",
  "abstract": "The MouseButtonSetting component configures mouse button settings within a SOFA simulation scene, allowing users to specify which buttons are used for specific interactions or operations.",
  "sheet": "# MouseButtonSetting\n\n**Overview**\n\nMouseButtonSetting is part of the Sofa.Component.Setting module and inherits from ConfigurationSetting. It serves to configure mouse button settings within a simulation scene, enabling users to define which mouse buttons (Left, Middle, Right) are used for specific interactions or operations.\n\n**Parameters and Data**\n\n- **d_button**: Mouse button used (`sofa::helper::OptionsGroup`). This field allows the user to specify the mouse button that is utilized for certain operations within the simulation scene."
}