Data Fields

Methods

{
  "name": "OglSceneFrame",
  "namespace": "sofa::gl::component::rendering3d",
  "module": "Sofa.GL.Component.Rendering3D",
  "include": "sofa/gl/component/rendering3d/OglSceneFrame.h",
  "doc": "Display a frame at the corner of the scene view.",
  "inherits": [
    "VisualModel"
  ],
  "templates": [],
  "data_fields": [
    {
      "name": "d_drawFrame",
      "type": "bool",
      "xmlname": "draw",
      "help": "Display the frame or not"
    },
    {
      "name": "d_style",
      "type": "Style",
      "xmlname": "style",
      "help": "Style of the frame\\n"
    },
    {
      "name": "d_alignment",
      "type": "Alignment",
      "xmlname": "alignment",
      "help": "Alignment of the frame in the view\\n"
    },
    {
      "name": "d_viewportSize",
      "type": "int",
      "xmlname": "viewportSize",
      "help": "Size of the viewport where the frame is rendered"
    }
  ],
  "links": [],
  "methods": [
    {
      "name": "doDrawVisual",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::visual::VisualParams *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The **OglSceneFrame** is a component in the SOFA framework designed for rendering purposes, specifically to display a frame at the corner of the scene view within a graphical interface. This component inherits from `VisualModel`, indicating its role in visual representation and integration with other visual components in SOFA.\n\nIt provides several data fields for customization:\n- **draw**: A boolean field (`d_drawFrame`) that controls whether the frame is displayed or not.\n- **style**: A field (`d_style`) that defines the style of the frame, allowing for different appearances.\n- **alignment**: An alignment field (`d_alignment`) that specifies where in the view the frame should be positioned (e.g., top-left, bottom-right).\n- **viewportSize**: An integer field (`d_viewportSize`) to specify the size of the viewport where the frame will be rendered.\n\nThe component implements a `doDrawVisual` method, which is part of its role as a visual model and is responsible for rendering the frame. This method takes a pointer to `core::visual::VisualParams`, indicating that it leverages core visualization parameters for drawing operations.",
  "maths": "The **OglSceneFrame** is a visualization component in the SOFA framework, primarily intended for rendering purposes. It does not contribute to any governing equations or operators involved in the Finite Element Method (FEM) simulation pipeline. The component's role is to display a frame at the corner of the scene view within a graphical interface, providing visual cues and enhancing user interaction with the simulation environment.\n\n### Mathematical and Physical Description\n\n#### Governing Equations and Operators\n- **OglSceneFrame** does not implement or contribute to any governing equations (e.g., mass matrix M, stiffness matrix K, internal force f_int, residual R) relevant to the FEM simulation pipeline. It is purely a visualization component.\n\n#### Constitutive or Kinematic Laws\n- This component does not involve any constitutive laws, kinematic laws, strain measures, stress tensors, hyperelastic potentials, damping models, or constraint Jacobians. Its purpose is strictly visual representation and user interaction support.\n\n#### Role in the Global FEM Pipeline\n- **OglSceneFrame** does not play a role in assembly, time integration, nonlinear solve, linear solve, or constraint handling within the global FEM simulation pipeline. It is independent of these numerical and mechanical processes.\n\n#### Numerical Methods and Discretization Choices\n- The component does not encode any specific numerical methods or discretization choices relevant to FEM. Its functionality is limited to rendering operations within the graphical interface.\n\n#### Variational / Lagrangian Mechanics Framework\n- **OglSceneFrame** does not fit into the broader variational or Lagrangian mechanics framework as it pertains strictly to visualization and user interaction rather than physical modeling or simulation.\n\n### Summary\nThe **OglSceneFrame** component is a purely visual element within SOFA, used for displaying frames in the graphical interface of simulations. It does not contribute any mathematical or mechanical content to the FEM simulation process.",
  "abstract": "The OglSceneFrame displays a frame at the corner of the scene view within a graphical interface, providing visual cues and enhancing user interaction with the simulation environment.",
  "sheet": "# OglSceneFrame\n\n**Overview:**\nThe OglSceneFrame is a visualization component in the SOFA framework designed to display a frame at the corner of the scene view. It inherits from `VisualModel` and provides customization options for its appearance and positioning.\n\n**Parameters and Data:**\nThe significant data fields exposed by this component are:\n- **draw**: A boolean field (`d_drawFrame`) that controls whether the frame is displayed or not.\n- **style**: A field (`d_style`) defining the style of the frame, allowing for different appearances.\n- **alignment**: An alignment field (`d_alignment`) specifying where in the view the frame should be positioned (e.g., top-left, bottom-right).\n- **viewportSize**: An integer field (`d_viewportSize`) to specify the size of the viewport where the frame will be rendered."
}