Add interactive bind to cycle backface culling modes by isaccunha · Pull Request #3126 · f3d-app/f3d

isaccunha · 2026-05-06T23:49:06Z

Describe your changes

This PR adds a command and a bind to control backface culling.

Issue ticket number and link if any

#2697

Checklist for finalizing the PR

I have performed a self-review of my code
I have added tests for new features and bugfixes
I have added documentation for new features
If it is a modifying the libf3d API, I have updated bindings
If it is a modifying the .github/workflows/versions.json, I have updated docker_timestamp

AI Disclosure

I did not use AI to generate any of the content of that pull request
I used AI to generate code in that pull request, if yes please disclose which part of the code was generated and with which model.
...

Continuous integration

Please write a comment to run CI, eg: \ci fast.
See here for more info.

mwestphal

looks good, please add tests and doc :)

mwestphal · 2026-06-04T11:27:54Z

  std::string CachePath;

  std::optional<std::string> BackfaceType;
+  std::map<vtkProperty*, bool> OriginalBackfaceCulling;


why do you need a bool on top of the property ?

Because the vtkProperty acts as a key for each material. We need the bool as a backup so when we cycle back to default, we can fully recover the original state for each part of the object.

Im really confused. the original vtkProperty should contain all the info you need, should it not ?

mwestphal · 2026-06-04T11:28:09Z

+
+    vtkProperty* prop = coloring.Actor->GetProperty();
+    vtkProperty* origProp = coloring.OriginalActor->GetProperty();
+    if (this->OriginalBackfaceCulling.count(prop) == 0)


find should be enough, no need to use count

mwestphal

questions and remarks

mwestphal · 2026-06-13T05:59:05Z

Need any help moving forward @isaccunha ? :)

isaccunha · 2026-06-14T00:51:45Z

I just pushed some changes, do you think it is ready and I can move on to testing and docs?

mwestphal · 2026-06-14T05:37:23Z

I just pushed some changes, do you think it is ready and I can move on to testing and docs?

Ill take a look :)

mwestphal

Still unclear in regards to the vtkProperty thing.

Lets discuss on discord if you can :)

mwestphal · 2026-07-05T05:22:12Z

Need any help moving forward @isaccunha ?

isaccunha · 2026-07-06T14:00:36Z

I am doing the refactor changes to the bug solution, but I'm still kinda lost, so I'll message you on discord.

Need any help moving forward @isaccunha ?

mwestphal · 2026-07-29T06:50:38Z

Hey @isaccunha , I dont think you messaged me on discord, do not hesitate to ping me there!

isaccunha · 2026-07-30T15:32:26Z

Hey @isaccunha , I dont think you messaged me on discord, do not hesitate to ping me there!

Yes I did, I am icee on discord, sorry to confuse you. Also I pushed the changes and think it is finally okay and the bug is solved. Do you think I can add docs and testing?

github-actions · 2026-07-30T15:39:46Z

Style Checks CI failed:

diff --git a/library/src/interactor_impl.cxx b/library/src/interactor_impl.cxx
index 42cb041..644669e 100644
--- a/library/src/interactor_impl.cxx
+++ b/library/src/interactor_impl.cxx
@@ -1003,7 +1003,7 @@ interactor& interactor_impl::initCommands()
       }
       else if (*type == "visible")
       {
-        type = "hidden";       
+        type = "hidden";
       }
       else if (*type == "hidden")
       {
@@ -1013,7 +1013,7 @@ interactor& interactor_impl::initCommands()
     },
     command_documentation_t{
       "cycle_backface_type", "cycle between backface culling modes (default, visible, hidden)" });
-  
+
   std::vector<std::string> cycleColoringValidArgs = { "field", "array", "component" };
   this->addCommand(
     "cycle_coloring",
@@ -1590,7 +1590,7 @@ interactor& interactor_impl::initBindings()
     const auto& type = this->Internals->Options.render.backface_type;
     if (!type.has_value())
     {
-      desc = "default"; 
+      desc = "default";
     }
     else
     {

You can copy the patch above and apply it locally with:

Platform	Command
X	`xclip -o -selection clipboard \| git apply -v`
Wayland	`wl-paste \| git apply -v`
Powershell	`Get-Clipboard -Raw \| git apply -v`
macOS	`pbpaste \| git apply -v`

…oloringStruct

mwestphal · 2026-08-06T06:38:30Z

  std::string CachePath;

  std::optional<std::string> BackfaceType;
+


Suggested change

mwestphal · 2026-08-06T06:39:59Z

  this->addBinding({mod_t::NONE, "P"}, "cycle render.effect.blending.mode", "Scene", std::bind(docStr, "Blending", std::cref(opts.render.effect.blending.mode)), f3d::interactor::BindingType::CYCLIC);
  this->addBinding({mod_t::NONE, "Q"}, "toggle render.effect.ambient_occlusion","Scene", std::bind(docTgl, "Ambient occlusion", std::cref(opts.render.effect.ambient_occlusion)), f3d::interactor::BindingType::TOGGLE);
  this->addBinding({mod_t::NONE, "A"}, "cycle render.effect.antialiasing.mode","Scene", std::bind(docStr, "Anti-aliasing", std::cref(opts.render.effect.antialiasing.mode)), f3d::interactor::BindingType::CYCLIC);
+  this->addBinding({mod_t::CTRL, "B"},"cycle_backface_type","Scene",docBackface,f3d::interactor::BindingType::CYCLIC);


Suggested change

this->addBinding({mod_t::CTRL, "B"},"cycle_backface_type","Scene",docBackface,f3d::interactor::BindingType::CYCLIC);

this->addBinding({mod_t::CTRL, "B"}, "cycle_backface_type", "Scene", docBackface, f3d::interactor::BindingType::CYCLIC);

mwestphal · 2026-08-06T06:43:39Z

    }
  };

+  // "Cycle backface type" , "visible/hidden/default"


f3d now supports "domains", you can drop this and declare a domain in options.json. See antialiasing mode for an example.

mwestphal · 2026-08-06T06:44:07Z

      "cycle_animation", "cycle scene.animation.index option using model information" });

+  this->addCommand(
+    "cycle_backface_type",


f3d now supports "domains", you can drop this and declare a domain in options.json. See antialiasing mode for an example.

mwestphal

f3d changed since them , so you need to update the logic with domains, but other than that it looks good!

mwestphal linked an issue May 7, 2026 that may be closed by this pull request

Add a bind to control backface culling #2697

Open

mwestphal self-requested a review May 7, 2026 05:44

mwestphal reviewed May 7, 2026

View reviewed changes

Comment thread vtkext/private/module/vtkF3DRenderer.cxx

mwestphal requested changes May 7, 2026

View reviewed changes

mwestphal requested review from mwestphal and removed request for mwestphal May 14, 2026 13:34

isaccunha requested a review from a team as a code owner June 4, 2026 09:35

mwestphal reviewed Jun 4, 2026

View reviewed changes

Comment thread vtkext/private/module/vtkF3DRenderer.cxx Outdated

mwestphal reviewed Jun 4, 2026

View reviewed changes

mwestphal requested changes Jun 4, 2026

View reviewed changes

mwestphal self-requested a review June 14, 2026 05:37

mwestphal reviewed Jun 14, 2026

View reviewed changes

Comment thread library/src/interactor_impl.cxx

mwestphal reviewed Jun 14, 2026

View reviewed changes

isaccunha added 4 commits August 6, 2026 01:24

feat: backface culling bind and command

ac0f4af

fix: restore default backface culling state during cycle

1b9f8ac

refactor: remove redundant original property caching

95a5fc2

refactor: replace backface culling map with full property backup in C…

40bf38b

…oloringStruct

isaccunha force-pushed the feat/backface-culling-bind branch from 610e28a to 40bf38b Compare August 6, 2026 04:42

mwestphal self-requested a review August 6, 2026 06:02

mwestphal reviewed Aug 6, 2026

View reviewed changes

mwestphal requested changes Aug 6, 2026

View reviewed changes

		std::string CachePath;

		std::optional<std::string> BackfaceType;

	this->addBinding({mod_t::CTRL, "B"},"cycle_backface_type","Scene",docBackface,f3d::interactor::BindingType::CYCLIC);
	this->addBinding({mod_t::CTRL, "B"}, "cycle_backface_type", "Scene", docBackface, f3d::interactor::BindingType::CYCLIC);

Uh oh!

Uh oh!

Conversation

isaccunha commented May 6, 2026

Describe your changes

Issue ticket number and link if any

Checklist for finalizing the PR

AI Disclosure

Continuous integration

Uh oh!

Uh oh!

mwestphal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mwestphal left a comment

Choose a reason for hiding this comment

Uh oh!

mwestphal commented Jun 13, 2026

Uh oh!

isaccunha commented Jun 14, 2026

Uh oh!

mwestphal commented Jun 14, 2026

Uh oh!

Uh oh!

mwestphal left a comment

Choose a reason for hiding this comment

Uh oh!

mwestphal commented Jul 5, 2026

Uh oh!

isaccunha commented Jul 6, 2026

Uh oh!

mwestphal commented Jul 29, 2026

Uh oh!

isaccunha commented Jul 30, 2026

Uh oh!

github-actions Bot commented Jul 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mwestphal left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Jul 30, 2026 •

edited

Loading