Methods

{
  "name": "AddFrameButtonSetting",
  "namespace": "sofa::gui::component",
  "module": "Sofa.GUI.Component",
  "include": "sofa/gui/component/AddFrameButtonSetting.h",
  "doc": "Button setting adding a frame to a skinned model.",
  "inherits": [
    "MouseButtonSetting"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "getOperationType",
      "return_type": "int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `AddFrameButtonSetting` is a GUI component in the SOFA framework designed to add a frame to a skinned model through button settings. It inherits from `sofa::component::setting::MouseButtonSetting`, which likely provides functionality related to mouse button interactions within the GUI. This component implements an operation type, identified by the method `getOperationType()`, which returns \"AddFrame\". The purpose of this component is to facilitate user interaction for adding frames in a skinned model through a graphical interface.",
  "maths": "The `AddFrameButtonSetting` is a GUI component within the SOFA framework designed to add frames to a skinned model through button settings. This component inherits from `sofa::component::setting::MouseButtonSetting`, indicating it provides functionality related to mouse button interactions within the graphical user interface (GUI). The primary role of this component is to facilitate user interaction for adding frames in a skinned model via the GUI, rather than contributing directly to the mathematical or physical aspects of the Finite Element Method (FEM) simulation pipeline.\n\nThe `getOperationType()` method returns the string `",
  "abstract": "The `AddFrameButtonSetting` facilitates adding frames to a skinned model through button settings in the SOFA GUI.",
  "sheet": "\n# AddFrameButtonSetting\n\n## Overview\nThe `AddFrameButtonSetting` is a GUI component that adds frames to a skinned model via button interactions. It inherits from `sofa::component::setting::MouseButtonSetting`, indicating it handles mouse button events within the SOFA graphical user interface.\n\n## Parameters and Data\nThis component does not expose any significant data fields or parameters beyond what is inherited from its parent class."
}