24 #ifndef PXR_BASE_PLUG_PLUGIN_H 25 #define PXR_BASE_PLUG_PLUGIN_H 28 #include "pxr/base/plug/api.h" 40 PXR_NAMESPACE_OPEN_SCOPE
44 class Plug_RegistrationMetadata;
70 #ifdef PXR_PYTHON_SUPPORT_ENABLED 73 #endif // PXR_PYTHON_SUPPORT_ENABLED 104 return _resourcePath;
115 PLUG_API std::string
FindPluginResource(
const std::string& path,
bool verify =
true)
const;
127 const std::string & name,
128 const std::string & resourcePath,
129 const JsObject & plugInfo,
133 static PlugPluginPtr _GetPluginForType(
const TfType & type);
136 static void _RegisterAllPlugins();
138 static PlugPluginPtr _GetPluginWithName(
const std::string& name);
140 static PlugPluginPtrVector _GetAllPlugins();
142 template <
class PluginMap>
144 static std::pair<PlugPluginPtr, bool>
145 _NewPlugin(
const Plug_RegistrationMetadata &metadata,
147 const std::string& pluginCreationPath,
148 PluginMap *allPluginsByNamePtr);
151 static std::pair<PlugPluginPtr, bool>
152 _NewDynamicLibraryPlugin(
const Plug_RegistrationMetadata& metadata);
154 #ifdef PXR_PYTHON_SUPPORT_ENABLED 156 static std::pair<PlugPluginPtr, bool>
157 _NewPythonModulePlugin(
const Plug_RegistrationMetadata& metadata);
158 #endif // PXR_PYTHON_SUPPORT_ENABLED 161 static std::pair<PlugPluginPtr, bool>
162 _NewResourcePlugin(
const Plug_RegistrationMetadata& metadata);
168 void _DeclareAliases(
TfType t,
const JsObject & metadata );
170 void _DeclareTypes();
172 void _DeclareType(
const std::string &name,
const JsObject &dict);
174 static void _DefineType(
TfType t );
178 bool _LoadWithDependents(_SeenPlugins * seenPlugins);
181 static void _UpdatePluginMaps(
const TfType & baseType );
184 static constexpr
char const *_GetPluginTypeDisplayName(_Type type);
189 std::string _resourcePath;
192 std::atomic<bool> _isLoaded;
204 PlugFindPluginResource(
const PlugPluginPtr& plugin,
205 const std::string& path,
bool verify =
true);
207 PXR_NAMESPACE_CLOSE_SCOPE
209 #endif // PXR_BASE_PLUG_PLUGIN_H PLUG_API bool IsPythonModule() const
Returns true if the plugin is a python module.
PLUG_API JsObject GetMetadata()
Returns the dictionary containing meta-data for the plugin.
Standard pointer typedefs.
Defines an interface for registering plugins.
PLUG_API JsObject GetMetadataForType(const TfType &type)
Returns the metadata sub-dictionary for a particular type.
std::string const & GetPath() const
Returns the plugin's filesystem path.
Pointer storage with deletion detection.
#define TF_DECLARE_WEAK_AND_REF_PTRS(type)
Define standard weak, ref, and vector pointer types.
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 JsObject GetDependencies()
Returns the dictionary containing the dependencies for the plugin.
Enable a concrete base class for use with TfRefPtr.
PLUG_API bool IsResource() const
Returns true if the plugin is resource-only.
Defines an interface to registered plugins.
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.
TfType represents a dynamic runtime type.
PLUG_API bool Load()
Loads the plugin.
PLUG_API bool DeclaresType(const TfType &type, bool includeSubclasses=false) const
Returns true if type is declared by this plugin.
Enable a concrete base class for use with TfWeakPtr.
std::string const & GetName() const
Returns the plugin's name.
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...