PlugPlugin Class Reference

#include <plugin.h>

Inheritance diagram for PlugPlugin:

Public Member Functions
PLUG_API	~PlugPlugin ()
PLUG_API bool	Load ()
PLUG_API bool	IsLoaded () const
PLUG_API bool	IsResource () const
	Returns true if the plugin is resource-only. More...
PLUG_API JsObject	GetMetadata ()
	Returns the dictionary containing meta-data for the plugin. More...
PLUG_API JsObject	GetMetadataForType (const TfType &type)
	Returns the metadata sub-dictionary for a particular type. More...
PLUG_API JsObject	GetDependencies ()
	Returns the dictionary containing the dependencies for the plugin. More...
PLUG_API bool	DeclaresType (const TfType &type, bool includeSubclasses=false) const
std::string const &	GetName () const
	Returns the plugin's name. More...
std::string const &	GetPath () const
	Returns the plugin's filesystem path. More...
std::string const &	GetResourcePath () const
	Returns the plugin's resources filesystem path. More...
PLUG_API std::string	MakeResourcePath (const std::string &path) const
PLUG_API std::string	FindPluginResource (const std::string &path, bool verify=true) const
Public Member Functions inherited from TfWeakBase
	TfWeakBase ()
	TfWeakBase (const TfWeakBase &)
const TfWeakBase &	__GetTfWeakBase__ () const
const TfWeakBase &	operator= (const TfWeakBase &)
void	EnableNotification2 () const
TF_API void const *	GetUniqueIdentifier () const

Friends
class	PlugRegistry

Additional Inherited Members
Protected Member Functions inherited from TfWeakBase
	~TfWeakBase ()
TfRefPtr< Tf_Remnant >	_Register () const
template<class T >
TfRefPtr< Tf_Remnant >	_Register (T *tempRmnt) const
bool	_HasRemnant () const

Detailed Description

Defines an interface to registered plugins.

Plugins are registered using the interfaces in PlugRegistry.

For each registered plugin, there is an instance of PlugPlugin which can be used to load and unload the plugin and to retrieve information about the classes implemented by the plugin.

Definition at line 57 of file plugin.h.

Constructor & Destructor Documentation

PLUG_API PlugPlugin::~PlugPlugin

(

)

Member Function Documentation

PLUG_API bool PlugPlugin::DeclaresType	(	const TfType &	type,
		bool	includeSubclasses = false
	)		const

Returns true if type is declared by this plugin. If includeSubclasses is specified, also returns true if any subclasses of type have been declared.

PLUG_API std::string PlugPlugin::FindPluginResource	(	const std::string &	path,
		bool	verify = true
	)		const

Find a plugin resource by absolute or relative path optionally verifying that file exists. If verification fails an empty path is returned. Relative paths are relative to the plugin's resource path.

PLUG_API JsObject PlugPlugin::GetDependencies

(

)

Returns the dictionary containing the dependencies for the plugin.

PLUG_API JsObject PlugPlugin::GetMetadata

(

)

Returns the dictionary containing meta-data for the plugin.

PLUG_API JsObject PlugPlugin::GetMetadataForType

(

const TfType &

type

)

Returns the metadata sub-dictionary for a particular type.

std::string const& PlugPlugin::GetName ( ) const

inline

Returns the plugin's name.

Definition at line 92 of file plugin.h.

std::string const& PlugPlugin::GetPath ( ) const

inline

Returns the plugin's filesystem path.

Definition at line 97 of file plugin.h.

std::string const& PlugPlugin::GetResourcePath ( ) const

inline

Returns the plugin's resources filesystem path.

Definition at line 102 of file plugin.h.

PLUG_API bool PlugPlugin::IsLoaded

(

)

const

Returns true if the plugin is currently loaded. Resource plugins always report as loaded.

PLUG_API bool PlugPlugin::IsResource

(

)

const

Returns true if the plugin is resource-only.

PLUG_API bool PlugPlugin::Load

(

)

Loads the plugin. This is a noop if the plugin is already loaded.

PLUG_API std::string PlugPlugin::MakeResourcePath

(

const std::string &

path

)

const

Build a plugin resource path by returning a given absolute path or combining the plugin's resource path with a given relative path.

Friends And Related Function Documentation

friend class PlugRegistry

friend

Definition at line 194 of file plugin.h.

---

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

• pxr/base/plug/plugin.h