Skip to content
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

Clear command #1836

Merged
merged 11 commits into from
Dec 30, 2024
Merged

Clear command #1836

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4bef2f5
Add clear command
0xfedcafe Dec 25, 2024
5fabb66
Merge branch 'f3d-app:master' into clear-command
0xfedcafe Dec 25, 2024
7cbaa64
linker fix & reformat
0xfedcafe Dec 25, 2024
934aa84
fix test
0xfedcafe Dec 26, 2024
b4f3367
removed excessive method & added test
0xfedcafe Dec 26, 2024
74b6aac
Merge branch 'f3d-app:master' into clear-command
0xfedcafe Dec 27, 2024
872e922
fixes
0xfedcafe Dec 27, 2024
6decf89
test fixes
0xfedcafe Dec 27, 2024
ccf034b
fixed test comment
0xfedcafe Dec 28, 2024
3df85f7
removed excessive method
0xfedcafe Dec 28, 2024
06ac7bc
sync
0xfedcafe Dec 28, 2024
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
1 change: 1 addition & 0 deletions application/testing/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -821,6 +821,7 @@ f3d_test(NAME TestInteractionConsoleOpenWarningClick DATA f3d.glb ARGS --positio
f3d_test(NAME TestInteractionConsoleToggleGrid DATA f3d.glb INTERACTION UI) #Escape;toggle render.grid.enable;Return;Escape
f3d_test(NAME TestInteractionConsoleInvalidCommand DATA f3d.glb INTERACTION UI) #Escape;foo;Return
f3d_test(NAME TestInteractionConsoleInvalidOption DATA f3d.glb INTERACTION UI) #Escape;toggle foo;Return
f3d_test(NAME TestInteractionConsoleClear DATA dragon.vtu INTERACTION UI) #Escape;clear;Return
mwestphal marked this conversation as resolved.
Show resolved Hide resolved
f3d_test(NAME TestInteractionConsoleTypingSceneInfo DATA f3d.glb INTERACTION UI) #Escape;e;Escape;printt;BackSpace;_scee;Left;Right;_info;Return
0xfedcafe marked this conversation as resolved.
Show resolved Hide resolved

if (F3D_MODULE_TINYFILEDIALOGS)
Expand Down
2 changes: 2 additions & 0 deletions doc/user/COMMANDS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ The libf3d provides a few commands, many related to manipulating libf3d (options

`reset option.name`: A command to reset a libf3d option to its default values, eg: `reset render.background.blur.coc`.

`clear`: A command to clear ImGui console. No argument.

`print option.name`: A command to print the value of an libf3d option, eg: `print scene.up.direction`.

`cycle_animation`: A specific command to cycle `scene.animation.index` option using model information, No argument.
Expand Down
18 changes: 18 additions & 0 deletions library/src/interactor_impl.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
#include "window_impl.h"

#include "vtkF3DConsoleOutputWindow.h"

#if F3D_MODULE_UI
#include "vtkF3DImguiConsole.h"
#endif

#include "vtkF3DInteractorEventRecorder.h"
#include "vtkF3DInteractorStyle.h"
#include "vtkF3DRenderer.h"
Expand Down Expand Up @@ -603,6 +608,19 @@ interactor& interactor_impl::initCommands()
check_args(args, 1, "reset");
this->Internals->Options.reset(args[0]);
});
this->addCommand("clear",
[&](const std::vector<std::string>& args)
{
check_args(args, 0, "clear");
#if F3D_MODULE_UI
vtkF3DImguiConsole* console =
vtkF3DImguiConsole::SafeDownCast(vtkOutputWindow::GetInstance());
if (console)
0xfedcafe marked this conversation as resolved.
Show resolved Hide resolved
{
console->Clear();
}
#endif
});
this->addCommand("print",
[&](const std::vector<std::string>& args)
{
Expand Down
6 changes: 6 additions & 0 deletions library/testing/TestSDKInteractorCommand.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ int TestSDKInteractorCommand(int argc, char* argv[])
inter.triggerCommand("reset render.hdri.file");
test("triggerCommand reset optional", options.render.hdri.file.has_value() == false);

// Test clear
#if F3D_MODULE_UI
inter.triggerCommand("print_scene_info");
test("triggerCommand clear", (inter.triggerCommand("clear") == true));
#endif
0xfedcafe marked this conversation as resolved.
Show resolved Hide resolved

// Test toggle
inter.triggerCommand("toggle model.scivis.cells");
test("triggerCommand toggle", options.model.scivis.cells == true);
Expand Down
3 changes: 3 additions & 0 deletions testing/baselines/TestInteractionConsoleClear.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
129 changes: 129 additions & 0 deletions testing/recordings/TestInteractionConsoleClear.log
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# StreamVersion 1.2
RenderEvent 0 0 0 0 0 0 0

KeyPressEvent 0 0 0 27 1 Escape 0
CharEvent 0 0 0 27 1 Escape 0
KeyReleaseEvent 0 0 0 27 1 Escape 0

KeyPressEvent 0 0 0 101 1 e 0
CharEvent 0 0 0 101 1 e 0
KeyReleaseEvent 0 0 0 101 1 e 0

KeyPressEvent 0 0 0 27 1 Escape 0
CharEvent 0 0 0 27 1 Escape 0
KeyReleaseEvent 0 0 0 27 1 Escape 0

KeyPressEvent 0 0 0 112 1 p 0
CharEvent 0 0 0 112 1 p 0
KeyReleaseEvent 0 0 0 112 1 p 0

KeyPressEvent 0 0 0 114 1 r 0
CharEvent 0 0 0 114 1 r 0
KeyReleaseEvent 0 0 0 114 1 r 0

KeyPressEvent 0 0 0 105 1 i 0
CharEvent 0 0 0 105 1 i 0
KeyReleaseEvent 0 0 0 105 1 i 0

KeyPressEvent 0 0 0 110 1 n 0
CharEvent 0 0 0 110 1 n 0
KeyReleaseEvent 0 0 0 110 1 n 0

KeyPressEvent 0 0 0 116 1 t 0
CharEvent 0 0 0 116 1 t 0
KeyReleaseEvent 0 0 0 116 1 t 0

KeyPressEvent 0 0 0 116 1 t 0
CharEvent 0 0 0 116 1 t 0
KeyReleaseEvent 0 0 0 116 1 t 0

KeyPressEvent 0 0 0 8 1 BackSpace 0
CharEvent 0 0 0 8 1 BackSpace 0
KeyReleaseEvent 0 0 0 8 1 BackSpace 0

KeyPressEvent 0 0 1 0 1 Shift_L 0
KeyPressEvent 0 0 1 95 1 underscore 0
CharEvent 0 0 1 95 1 underscore 0
KeyReleaseEvent 0 0 1 95 1 underscore 0
KeyReleaseEvent 0 0 0 0 1 Shift_L 0

KeyPressEvent 0 0 0 115 1 s 0
CharEvent 0 0 0 115 1 s 0
KeyReleaseEvent 0 0 0 115 1 s 0

KeyPressEvent 0 0 0 99 1 c 0
CharEvent 0 0 0 99 1 c 0
KeyReleaseEvent 0 0 0 99 1 c 0

KeyPressEvent 0 0 0 101 1 e 0
CharEvent 0 0 0 101 1 e 0
KeyReleaseEvent 0 0 0 101 1 e 0

KeyPressEvent 0 0 0 101 1 e 0
CharEvent 0 0 0 101 1 e 0
KeyReleaseEvent 0 0 0 101 1 e 0

KeyPressEvent 0 0 0 0 1 Left 0
KeyReleaseEvent 0 0 0 0 1 Left 0

KeyPressEvent 0 0 0 110 1 n 0
CharEvent 0 0 0 110 1 n 0
KeyReleaseEvent 0 0 0 110 1 n 0

KeyPressEvent 0 0 0 0 1 Right 0
KeyReleaseEvent 0 0 0 0 1 Right 0

KeyPressEvent 0 0 1 0 1 Shift_L 0
KeyPressEvent 0 0 1 95 1 underscore 0
CharEvent 0 0 1 95 1 underscore 0
KeyReleaseEvent 0 0 1 95 1 underscore 0
KeyReleaseEvent 0 0 0 0 1 Shift_L 0

KeyPressEvent 0 0 0 105 1 i 0
CharEvent 0 0 0 105 1 i 0
KeyReleaseEvent 0 0 0 105 1 i 0

KeyPressEvent 0 0 0 110 1 n 0
CharEvent 0 0 0 110 1 n 0
KeyReleaseEvent 0 0 0 110 1 n 0

KeyPressEvent 0 0 0 102 1 f 0
CharEvent 0 0 0 102 1 f 0
KeyReleaseEvent 0 0 0 102 1 f 0

KeyPressEvent 0 0 0 111 1 o 0
CharEvent 0 0 0 111 1 o 0
KeyReleaseEvent 0 0 0 111 1 o 0

KeyPressEvent 0 0 0 13 1 Return 0
CharEvent 0 0 0 13 1 Return 0
KeyReleaseEvent 0 0 0 13 1 Return 0

KeyPressEvent 0 0 0 99 1 c 0
CharEvent 0 0 0 99 1 c 0
KeyReleaseEvent 0 0 0 99 1 c 0


KeyPressEvent 0 0 0 108 1 l 0
CharEvent 0 0 0 108 1 l 0
KeyReleaseEvent 0 0 0 108 1 l 0


KeyPressEvent 0 0 0 101 1 e 0
CharEvent 0 0 0 101 1 e 0
KeyReleaseEvent 0 0 0 101 1 e 0


KeyPressEvent 0 0 0 97 1 a 0
CharEvent 0 0 0 97 1 a 0
KeyReleaseEvent 0 0 0 97 1 a 0


KeyPressEvent 0 0 0 114 1 r 0
CharEvent 0 0 0 114 1 r 0
KeyReleaseEvent 0 0 0 114 1 r 0


KeyPressEvent 0 0 0 13 1 Return 0
CharEvent 0 0 0 13 1 Return 0
KeyReleaseEvent 0 0 0 13 1 Return 0
0xfedcafe marked this conversation as resolved.
Show resolved Hide resolved
10 changes: 10 additions & 0 deletions vtkext/private/module/vtkF3DImguiActor.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,3 +462,13 @@
ImGuiIO& io = ImGui::GetIO();
io.DeltaTime = time;
}

//----------------------------------------------------------------------------
void vtkF3DImguiActor::Clear()

Check warning on line 467 in vtkext/private/module/vtkF3DImguiActor.cxx

View check run for this annotation

Codecov / codecov/patch

vtkext/private/module/vtkF3DImguiActor.cxx#L467 

Added line #L467 was not covered by tests
{
vtkF3DImguiConsole* console = vtkF3DImguiConsole::SafeDownCast(vtkOutputWindow::GetInstance());
if (console)

Check warning on line 470 in vtkext/private/module/vtkF3DImguiActor.cxx

View check run for this annotation

Codecov / codecov/patch

vtkext/private/module/vtkF3DImguiActor.cxx#L469-L470 

Added lines #L469 - L470 were not covered by tests
{
console->Clear();

Check warning on line 472 in vtkext/private/module/vtkF3DImguiActor.cxx

View check run for this annotation

Codecov / codecov/patch

vtkext/private/module/vtkF3DImguiActor.cxx#L472 

Added line #L472 was not covered by tests
}
}

Check warning on line 474 in vtkext/private/module/vtkF3DImguiActor.cxx

View check run for this annotation

Codecov / codecov/patch

vtkext/private/module/vtkF3DImguiActor.cxx#L474 

Added line #L474 was not covered by tests
5 changes: 5 additions & 0 deletions vtkext/private/module/vtkF3DImguiActor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ class vtkF3DImguiActor : public vtkF3DUIActor
*/
void RenderConsoleBadge() override;

/**
* Clear console
*/
void Clear() override;
0xfedcafe marked this conversation as resolved.
Show resolved Hide resolved

private:
vtkF3DImguiActor(const vtkF3DImguiActor&) = delete;
void operator=(const vtkF3DImguiActor&) = delete;
Expand Down
8 changes: 8 additions & 0 deletions vtkext/private/module/vtkF3DImguiConsole.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,3 +197,11 @@ void vtkF3DImguiConsole::ShowBadge()
ImGui::End();
}
}

//----------------------------------------------------------------------------
void vtkF3DImguiConsole::Clear()
{
this->Pimpl->Logs.clear();
this->Pimpl->NewError = false;
this->Pimpl->NewWarning = false;
}
5 changes: 5 additions & 0 deletions vtkext/private/module/vtkF3DImguiConsole.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ class vtkF3DImguiConsole : public vtkF3DConsoleOutputWindow
*/
void ShowBadge();

/**
* Clear console
*/
void Clear();

protected:
vtkF3DImguiConsole();
~vtkF3DImguiConsole() override;
Expand Down
5 changes: 5 additions & 0 deletions vtkext/private/module/vtkF3DUIActor.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,11 @@
*/
virtual void SetDeltaTime(double) {}

/**
* Clear console
*/
virtual void Clear() {}

Check warning on line 102 in vtkext/private/module/vtkF3DUIActor.h

View check run for this annotation

Codecov / codecov/patch

vtkext/private/module/vtkF3DUIActor.h#L102 

Added line #L102 was not covered by tests
0xfedcafe marked this conversation as resolved.
Show resolved Hide resolved

protected:
vtkF3DUIActor();
~vtkF3DUIActor() override;
Expand Down
Loading