7#ifndef PXR_BASE_PLUG_PLUGIN_H
8#define PXR_BASE_PLUG_PLUGIN_H
11#include "pxr/base/plug/api.h"
22PXR_NAMESPACE_OPEN_SCOPE
26class Plug_RegistrationMetadata;
52#ifdef PXR_PYTHON_SUPPORT_ENABLED
109 const std::string & name,
110 const std::string & resourcePath,
111 const JsObject & plugInfo,
115 static PlugPluginPtr _GetPluginForType(
const TfType & type);
118 static void _RegisterAllPlugins();
120 static PlugPluginPtr _GetPluginWithName(
const std::string& name);
122 static PlugPluginPtrVector _GetAllPlugins();
124 template <
class PluginMap>
126 static std::pair<PlugPluginPtr, bool>
127 _NewPlugin(
const Plug_RegistrationMetadata &metadata,
129 const std::string& pluginCreationPath,
130 PluginMap *allPluginsByNamePtr);
133 static std::pair<PlugPluginPtr, bool>
134 _NewDynamicLibraryPlugin(
const Plug_RegistrationMetadata& metadata);
136#ifdef PXR_PYTHON_SUPPORT_ENABLED
138 static std::pair<PlugPluginPtr, bool>
139 _NewPythonModulePlugin(
const Plug_RegistrationMetadata& metadata);
143 static std::pair<PlugPluginPtr, bool>
144 _NewResourcePlugin(
const Plug_RegistrationMetadata& metadata);
150 void _DeclareAliases(
TfType t,
const JsObject & metadata );
152 void _DeclareTypes();
154 void _DeclareType(
const std::string &name,
const JsObject &dict);
156 static void _DefineType(
TfType t );
160 bool _LoadWithDependents(_SeenPlugins * seenPlugins);
163 static void _UpdatePluginMaps(
const TfType & baseType );
166 static constexpr char const *_GetPluginTypeDisplayName(_Type type);
171 std::string _resourcePath;
174 std::atomic<bool> _isLoaded;
186PlugFindPluginResource(
const PlugPluginPtr& plugin,
187 const std::string& path,
bool verify =
true);
189PXR_NAMESPACE_CLOSE_SCOPE
Defines an interface to registered plugins.
std::string const & GetName() const
Returns the plugin's name.
std::string const & GetResourcePath() const
Returns the plugin's resources filesystem path.
PLUG_API bool IsLoaded() const
Returns true if the plugin is currently loaded.
PLUG_API JsObject GetMetadataForType(const TfType &type)
Returns the metadata sub-dictionary for a particular type.
PLUG_API bool DeclaresType(const TfType &type, bool includeSubclasses=false) const
Returns true if type is declared by this plugin.
PLUG_API JsObject GetDependencies()
Returns the dictionary containing the dependencies for the plugin.
PLUG_API std::string MakeResourcePath(const std::string &path) const
Build a plugin resource path by returning a given absolute path or combining the plugin's resource pa...
std::string const & GetPath() const
Returns the plugin's filesystem path.
PLUG_API bool Load()
Loads the plugin.
PLUG_API JsObject GetMetadata()
Returns the dictionary containing meta-data for the plugin.
PLUG_API std::string FindPluginResource(const std::string &path, bool verify=true) const
Find a plugin resource by absolute or relative path optionally verifying that file exists.
PLUG_API bool IsPythonModule() const
Returns true if the plugin is a python module.
PLUG_API bool IsResource() const
Returns true if the plugin is resource-only.
Defines an interface for registering plugins.
TfType represents a dynamic runtime type.
Enable a concrete base class for use with TfWeakPtr.
Standard pointer typedefs.
#define TF_DECLARE_WEAK_PTRS(type)
Define standard weak pointer types.