Refactoring ideas

[mwestphal]

This thread is meant to discuss code improvements. It can be edited by everyone.

Use sub-folders

Architecture may be improve by splitting files in folders:

• Core
• Data
• Filters
• Rendering
• Interactors
• Options
• ...
  please, edit this list, I am not the best fit to fill it.

Use namespaces

• create new namespaces for
  • f3d
  • exceptions f3d::except?
  • subfolders (see thread: f3d::filter, f3d::data, ... may be too verbose.)
• change the clang-format to avoid re-indenting everything (see NamespaceIndentation)

Add CMake Preset for build / testing

• build
  • minimal (the lightest version)
  • ray-tracing
  • testing

Class splitting/reorganization

...

Misc

• enforce C++ 11 in clang-format and CMake
  • switch to C++ 14 ?
• use #pragma once

[mwestphal]

https://gitlab.kitware.com/f3d/f3d/-/issues/227

[mwestphal]

Looking at this again.

Here is my suggestion:

cmake
  .cmake files
testing
  baselines
    lfs .png baseline files
  data
    lfs testing data files
  recordings
    .log files
documentation
  unchanged
resources
  resources file
libf3d
  core
      F3DAnimationManager
      F3DException
      F3DLoader (Split in two with a F3DInit/F3DStarter)
      F3DLog
      F3DNSDelegate
      F3DOffscreenRender
      F3DOptions
      Config -> Should be renammed F3DConfig
      F3DIncludes -> To be merged with F3DConfig ?
   readers
      unchanged
   specific
      F3DNSDelegate
   third_party
      cxxopts.hpp
   VTKExtensions
    IO
      vtkF3DGenericImporter
      vtkF3DMetaReader
      vtkF3DOCCTReader
      vtkF3DAssimpImporter
    Interaction
      vtkF3DInteractorEventRecorder
      vtkF3DInteractorStyle
    Rendering
      vtkF3DOpenGLGridMapper
      vtkF3DPolyDataMapper
      vtkF3DRenderPass
      vtkF3DRenderer
      vtkF3DRendererWithColoring
    Misc
      vtkF3DConsoleOutputWindow
      vtkF3DObjectFactory
      vtkF3DPostProcessFilter
      vtkF3DWin32OutputWindow
exec
  embed.cxx
  main.cxx
winshellext
  unchanged

@Meakk @CharlesGueunet @Meakk

[mwestphal]

@CharlesGueunet @Meakk : Regarding this namespace discussion: https://gitlab.kitware.com/f3d/f3d/-/issues/227#note_942471

I still am not sure of what you mean and how to set it up, I'll let you take the lead on this.

[mwestphal]

@CharlesGueunet pragma once is still a no imo: https://stackoverflow.com/questions/1143936/pragma-once-vs-include-guards

[mwestphal]

Regarding the F3DLoader/F3DStarter separation, it try to separate the starting from the file loading, the resulting signature for the constructor of the F3DLoader would looke like this:

F3DLoader(const F3DOption& CommandLineOptions, F3DOptionsParser& parser, F3DOptions& options, F3DAnimationManager& animationManager, vtkF3DRenderer* renderer, vtkRenderWindow* renWin);

It can be done be not that beneficial

[mwestphal]

This will need to wait #173 and #52

[mwestphal]

This has largely been done in #203 #273 #278 #255 #285 #293