Skip to content

🌀 Clarify Plugin Name and Dependencies #11

@RafaelPalomar

Description

@RafaelPalomar

📝 Description

The name SofaIGTLink can be misleading in its current usage. In the context of Slicer-SOFA, this component is utilized without requiring an OpenIGTLink connection. For example, the SoftTissueSimulation module does not depend on OpenIGTLink functionality.

Furthermore, the inclusion of OpenIGTLink functionality introduces it as a dependency, even when it may not be necessary.

🔍 Problem Details

  • The current name (SofaIGTLink) implies a direct connection with OpenIGTLink, which is not always the case.
  • The added dependency on OpenIGTLink is unnecessary for scenarios where it is not being used.
  • It may still be beneficial to retain the ability for SOFA to communicate through OpenIGTLink for specific use cases.

🛠️ Proposed Solutions

  1. Make OpenIGTLink Configurable and Rename the Plugin

    • Allow users to enable or disable OpenIGTLink functionality during configuration time.
      • Reduces unnecessary dependencies when OpenIGTLink is not needed.
      • Simplifies integration into projects like Slicer-SOFA that do not rely on OpenIGTLink.
    • Use a more generic name that reflects its broader usage beyond OpenIGTLink.
  2. Split into Separate Plugins

    • Create two distinct plugins:
      • A core plugin for general functionality.
      • A dedicated plugin for OpenIGTLink communication.
    • Benefits:
      • Clear separation of concerns.
      • Flexibility for projects to include only the needed functionality.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions