From aad7fe7e436b9f3466fb34d89c689de125b06f2c Mon Sep 17 00:00:00 2001 From: Mathieu Westphal Date: Thu, 26 Dec 2024 07:44:57 +0100 Subject: [PATCH 1/2] doc: Engine change related doc --- doc/libf3d/LANGUAGE_BINDINGS.md | 2 +- doc/libf3d/OVERVIEW.md | 8 ++++---- doc/libf3d/PLUGINS.md | 1 + 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/libf3d/LANGUAGE_BINDINGS.md b/doc/libf3d/LANGUAGE_BINDINGS.md index fdf7418cf8..d88b99b086 100644 --- a/doc/libf3d/LANGUAGE_BINDINGS.md +++ b/doc/libf3d/LANGUAGE_BINDINGS.md @@ -9,7 +9,7 @@ Here is an example showing how to use libf3d python bindings: ```python import f3d -eng = f3d.Engine(f3d.Window.NATIVE) +eng = f3d.Engine.create(False) eng.options.update({ "model.scivis.array-name": "Normals", "model.scivis.component": 0, diff --git a/doc/libf3d/OVERVIEW.md b/doc/libf3d/OVERVIEW.md index 59da97ab2f..468ad24cc2 100644 --- a/doc/libf3d/OVERVIEW.md +++ b/doc/libf3d/OVERVIEW.md @@ -19,7 +19,7 @@ Rendering a file and starting the interaction is very easy: f3d::engine::autoloadPlugins(); // Create a f3d::engine -f3d::engine eng(); +f3d::engine eng = f3d::engine::create(); // Add a file into a scene eng.getScene().add("path/to/file.ext"); @@ -39,7 +39,7 @@ As well as loading multiple files: f3d::engine::autoloadPlugins(); // Create a f3d::engine -f3d::engine eng(); +f3d::engine eng = f3d::engine::create(); // Load multiples geometries eng.getScene().add({"path/to/file.ext", "path/to/file2.ext"}); @@ -56,7 +56,7 @@ It's also possible to load a geometry from memory buffers: #include // Create a f3d::engine -f3d::engine eng(); +f3d::engine eng = f3d::engine::create(); // Create a single triangle f3d::mesh_t mesh = {}; @@ -105,7 +105,7 @@ Changing some options can be done this way: f3d::engine::autoloadPlugins(); // Create a f3d::engine -f3d::engine eng(); +f3d::engine eng = f3d::engine::create(); // Recover the options and set the wanted value options& opt = eng.getOptions(); diff --git a/doc/libf3d/PLUGINS.md b/doc/libf3d/PLUGINS.md index 5d0a90946e..06c95ab455 100644 --- a/doc/libf3d/PLUGINS.md +++ b/doc/libf3d/PLUGINS.md @@ -69,5 +69,6 @@ F3D provides access to a VTK modules containing utilities that may be useful for - `vtkF3DFaceVaryingPointDispatcher`: A VTK filter that manipulates point data so that F3D can display them as face-varying data (used by `usd` plugin) - `vtkF3DBitonicSort`: A VTK class that perform Bitonic Sort algorithm on the GPU (used by the `splat` point sprites rendering algorithm - `vtkF3DImporter`: An Importer class that abstract away support for different version of VTK after some API changes. + - `vtkF3DGLTFImporter`: An custom glTF importer class that support armatures, usefull when creating other plugin supporting glTF extensions. For the complete documentation, please consult the [vtkext doxygen documentation.](https://f3d.app/doc/libf3d/vtkext_doxygen/). From c0e31d7ed1a798204f29fde20cced48911b7a762 Mon Sep 17 00:00:00 2001 From: Mathieu Westphal Date: Thu, 26 Dec 2024 09:00:54 +0100 Subject: [PATCH 2/2] Update doc/libf3d/PLUGINS.md Co-authored-by: Michael MIGLIORE --- doc/libf3d/PLUGINS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/libf3d/PLUGINS.md b/doc/libf3d/PLUGINS.md index 06c95ab455..26e0f2c20f 100644 --- a/doc/libf3d/PLUGINS.md +++ b/doc/libf3d/PLUGINS.md @@ -69,6 +69,6 @@ F3D provides access to a VTK modules containing utilities that may be useful for - `vtkF3DFaceVaryingPointDispatcher`: A VTK filter that manipulates point data so that F3D can display them as face-varying data (used by `usd` plugin) - `vtkF3DBitonicSort`: A VTK class that perform Bitonic Sort algorithm on the GPU (used by the `splat` point sprites rendering algorithm - `vtkF3DImporter`: An Importer class that abstract away support for different version of VTK after some API changes. - - `vtkF3DGLTFImporter`: An custom glTF importer class that support armatures, usefull when creating other plugin supporting glTF extensions. + - `vtkF3DGLTFImporter`: An custom glTF importer class that support armatures, useful when creating other plugin supporting glTF extensions. For the complete documentation, please consult the [vtkext doxygen documentation.](https://f3d.app/doc/libf3d/vtkext_doxygen/).