Methods

{
  "name": "SimulationInitTexturesDoneEvent",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/events/SimulationInitTexturesDoneEvent.h",
  "doc": "Event fired when sofa::simulation::Simulation::initTextures has been called.",
  "inherits": [
    "Event"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "getEventTypeIndex",
      "return_type": "int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "checkEventType",
      "return_type": "bool",
      "params": [
        {
          "name": "event",
          "type": "const Event *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "GetClassName",
      "return_type": "const char *",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    }
  ],
  "description": "The `SimulationInitTexturesDoneEvent` is an event class in the SOFA framework, specifically within the `sofa::simulation` namespace. This event is fired when the `initTextures` method of the `sofa::simulation::Simulation` class has been completed. It inherits from the base `Event` class and does not have any data fields or specific links to other components.\n\nThe component primarily serves as a notification mechanism within the SOFA simulation pipeline, indicating that texture initialization is complete. This can be useful for triggering subsequent steps in the rendering or visualization process.\n\nIt provides methods such as `getEventTypeIndex`, which returns an integer representing its type index; `checkEventType`, which statically checks if a given event matches this specific event type; and `GetClassName`, which returns the class name as a string. These methods facilitate event handling within the framework, enabling components to identify and react appropriately to the `SimulationInitTexturesDoneEvent`.\n\nPractically, it can be used in scenarios where texture initialization is critical for the simulation's visual output or further processing steps that depend on properly initialized textures.",
  "maths": "The `SimulationInitTexturesDoneEvent` is an event class within the SOFA framework, specifically in the `sofa::simulation` namespace. This event is fired when the texture initialization process (`initTextures`) has been completed by the `sofa::simulation::Simulation` class. It serves as a notification mechanism for subsequent stages of the simulation pipeline that depend on properly initialized textures.\n\nFrom a mathematical and physical perspective, this component does not directly contribute to the governing equations or operators typically involved in FEM simulations such as the mass matrix \\(M\\), stiffness matrix \\(K\\), internal force vector \\(f_{int}\\), residual vector \\(R\\), strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc. It is not involved in the assembly phase, time integration schemes, nonlinear resolution methods, linear solve procedures, or constraint handling mechanisms.\n\nInstead, its role is primarily infrastructural and informational within the simulation framework:\n- **Role**: The event notifies other components that texture initialization has been completed, allowing them to proceed with further steps such as visualization, rendering, or any post-initialization processing that depends on textures being ready. It does not alter or influence the physical or mechanical state of the simulated system.\n\nIn summary, `SimulationInitTexturesDoneEvent` is a pure event-handling component and does not contribute to the core FEM simulation pipeline's mathematical structure.",
  "abstract": "Notifies other components in the SOFA simulation pipeline that texture initialization has been completed.",
  "sheet": "\n# SimulationInitTexturesDoneEvent\n\n**Overview**\nThe `SimulationInitTexturesDoneEvent` is an event class within the SOFA framework, specifically in the `sofa::simulation` namespace. It notifies other components when the `initTextures` method of the `sofa::simulation::Simulation` class has been completed. This event does not have any mathematical content or data fields and serves as a notification mechanism for subsequent stages that depend on properly initialized textures.\n\n**Practical Notes**\nThe event is primarily used to trigger further steps in the rendering or visualization process after texture initialization is complete. It ensures that components can proceed with their tasks only when all necessary textures are ready, maintaining the integrity of the simulation's visual output."
}