DD::Image::PluginObject Class Reference

#include <PluginObject.h>

Inheritance diagram for DD::Image::PluginObject:

Classes
class	Description

Static Public Member Functions
static const fdk::StringList &	FindPlugins (const char *pluginPrefix, const char *pluginSuffix, bool findBuiltins, bool findExternals, bool forceRefresh=false)

Static Protected Member Functions
static const PluginObject::Description *	_create (const std::string_view &className, const std::string_view &pluginPrefix, const std::string_view &pluginSuffix)
	Subclasses call this with their custom prefix & suffix.

Detailed Description

Abstract base class for object classes that load via a plugin. This can be used for non-Op functions like shaders, readers, writers, etc that add functionality but are not intended to be visible in the Nuke nodegraph like Ops are.

A common example of this are the reader/writer plugins that the Read and Write Ops load to handle file types. They expose Knob functionality on the Read and Write UI panels but the plugin objects are invisible to the nodegraph and local to the Ops, which manage their allocation.

Member Function Documentation

FindPlugins()

const fdk::StringList & PluginObject::FindPlugins ( const char *  pluginPrefix, const char *  pluginSuffix, bool  findBuiltins, bool  findExternals, bool  forceRefresh = false  )

static

Find all plugins matching the <prefix>Foo<suffix> naming style. This searches the current plugin paths and the list of built in (compiled in) plugins. The result of the search is cached so repeated calls with the same prefix and suffix is fast. Note - the names in the returned list are the pluginClass() strings, not the full name, since just the class name is typically wanted in menus.

References DD::Image::getPluginPath(), DD::Image::plugin_ext, and DD::Image::plugin_path_list().

Referenced by DD::Image::ProjectionFunc::FindPlugins().