Skip to content

[Framework] Apply template method design pattern to BaseVisualStyle #5441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lbinria wants to merge 3 commits into
base: master
Choose a base branch
from
+33 −6
Open

[Framework] Apply template method design pattern to BaseVisualStyle #5441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
16ac85d
[Framework] Apply template method design pattern to BaseVisualStyle
lbinria May 12, 2025
e61cdb4
Merge branch 'master' into 2025_sprintsed_BaseVisualStyle
bakpaul Jan 6, 2026
a929769
Merge branch 'master' into 2025_sprintsed_BaseVisualStyle
bakpaul Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Sofa/Component/Visual/src/sofa/component/visual/VisualStyle.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,14 @@ void VisualStyle::bwdInit()
applyBackupFlags(sofa::core::visual::VisualParams::defaultInstance());
}

void VisualStyle::updateVisualFlags(VisualParams* vparams)

void VisualStyle::doUpdateVisualFlags(VisualParams* vparams)
{
backupFlags = vparams->displayFlags();
vparams->displayFlags() = sofa::core::visual::merge_displayFlags(backupFlags, d_displayFlags.getValue());
}

void VisualStyle::applyBackupFlags(VisualParams* vparams)
void VisualStyle::doApplyBackupFlags(VisualParams* vparams)
{
vparams->displayFlags() = backupFlags;
}
Expand Down
4 changes: 2 additions & 2 deletions Sofa/Component/Visual/src/sofa/component/visual/VisualStyle.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ class SOFA_COMPONENT_VISUAL_API VisualStyle : public sofa::core::visual::BaseVis
protected:
VisualStyle();
public:
void doUpdateVisualFlags(VisualParams* ) override;
void doApplyBackupFlags(VisualParams* ) override;
void init() override;
void bwdInit() override;
void updateVisualFlags(VisualParams* ) override;
void applyBackupFlags(VisualParams* ) override;

bool insertInNode(sofa::core::objectmodel::BaseNode* node) override;
bool removeInNode(sofa::core::objectmodel::BaseNode* node) override;
Expand Down
30 changes: 28 additions & 2 deletions Sofa/framework/Core/src/sofa/core/visual/BaseVisualStyle.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,35 @@ class SOFA_CORE_API BaseVisualStyle : public sofa::core::objectmodel::BaseCompon
BaseVisualStyle() { }
~BaseVisualStyle() override { }

virtual void doUpdateVisualFlags(VisualParams* ) { };
virtual void doApplyBackupFlags(VisualParams* ) { };

public:
virtual void updateVisualFlags(VisualParams* ) { };
virtual void applyBackupFlags(VisualParams* ) { };
/**
* !!! WARNING since v25.12 !!!
*
* The template method pattern has been applied to this part of the API.
* This method calls the newly introduced method "doUpdateVisualFlags" internally,
* which is the method to override from now on.
*
**/
virtual void updateVisualFlags(VisualParams* vparams) final {
//TODO (SPRINT SED 2025): Component state mechamism
return this->doUpdateVisualFlags(vparams);
};

/**
* !!! WARNING since v25.12 !!!
*
* The template method pattern has been applied to this part of the API.
* This method calls the newly introduced method "doApplyBackupFlags" internally,
* which is the method to override from now on.
*
**/
virtual void applyBackupFlags(VisualParams* vparams) final {
//TODO (SPRINT SED 2025): Component state mechamism
return this->doApplyBackupFlags(vparams);
};

};

Expand Down
Loading