VTK  9.3.20240720
Public Types | Static Public Member Functions | Protected Member Functions | List of all members
vtkGLSLModifierFactory Class Reference

This class empowers developers to write and use GLSL mods eaisly in VTK. More...

#include <vtkGLSLModifierFactory.h>

Public Types

using NewModFunction = std::function< vtkGLSLModifierBase *(void *userData)>
 

Static Public Member Functions

static vtkGLSLModifierBaseCreateAMod (const std::string &modName)
 Used by VTK to create a mod for rendering.
 
static void RegisterAMod (const std::string &modName, NewModFunction createFunction, void *userData=nullptr)
 Developers should register runtime GLSL mods by invoking this function.
 

Protected Member Functions

 vtkGLSLModifierFactory ()=default
 
 ~vtkGLSLModifierFactory ()=default
 

Detailed Description

This class empowers developers to write and use GLSL mods eaisly in VTK.

For example, the mod classes could be registered via plugins.

Definition at line 22 of file vtkGLSLModifierFactory.h.

Member Typedef Documentation

◆ NewModFunction

using vtkGLSLModifierFactory::NewModFunction = std::function<vtkGLSLModifierBase*(void* userData)>

Definition at line 25 of file vtkGLSLModifierFactory.h.

Constructor & Destructor Documentation

◆ vtkGLSLModifierFactory()

vtkGLSLModifierFactory::vtkGLSLModifierFactory ( )
protecteddefault

◆ ~vtkGLSLModifierFactory()

vtkGLSLModifierFactory::~vtkGLSLModifierFactory ( )
protecteddefault

Member Function Documentation

◆ CreateAMod()

static vtkGLSLModifierBase * vtkGLSLModifierFactory::CreateAMod ( const std::string &  modName)
static

Used by VTK to create a mod for rendering.

◆ RegisterAMod()

static void vtkGLSLModifierFactory::RegisterAMod ( const std::string &  modName,
NewModFunction  createFunction,
void *  userData = nullptr 
)
static

Developers should register runtime GLSL mods by invoking this function.

Parameters
modNamename of your mod's C++ class.
createFunctiona function that VTK will call to create your mod.
userDatapass any application specific data that you feel is necessary while initializing your mod.

The documentation for this class was generated from the following file: