All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdImagingAdapterRegistry Class Reference

Registry of PrimAdapter plug-ins. More...

+ Inheritance diagram for UsdImagingAdapterRegistry:

Public Member Functions

USDIMAGING_API bool HasAdapter (TfToken const &adapterKey)
 Returns true if an adapter has been registered to handle the given adapterKey. More...
 
USDIMAGING_API
UsdImagingPrimAdapterSharedPtr 
ConstructAdapter (TfToken const &adapterKey)
 Returns a new instance of the UsdImagingPrimAdapter that has been registered to handle the given adapterKey. More...
 

Static Public Member Functions

static USDIMAGING_API bool AreExternalPluginsEnabled ()
 Returns true if external plugins are enabled. More...
 
static USDIMAGING_API
UsdImagingAdapterRegistry
GetInstance ()
 
- Static Public Member Functions inherited from TfSingleton< UsdImagingAdapterRegistry >
static UsdImagingAdapterRegistryGetInstance ()
 Return a reference to an object of type T, creating it if necessary. More...
 
static bool CurrentlyExists ()
 Return whether or not the single object of type T is currently in existence. More...
 
static void SetInstanceConstructed (UsdImagingAdapterRegistry &instance)
 Indicate that the sole instance object has already been created. More...
 
static void DeleteInstance ()
 Destroy the sole instance object of type T, if it exists. More...
 

Friends

class TfSingleton< UsdImagingAdapterRegistry >
 

Detailed Description

Registry of PrimAdapter plug-ins.

Definition at line 56 of file adapterRegistry.h.

Member Function Documentation

static USDIMAGING_API bool AreExternalPluginsEnabled ( )
static

Returns true if external plugins are enabled.

Internal plugins have isInternal=1 set in their metadata. This flag is only intended to be set for critical imaging plugins (mesh, cube, sphere, curve, etc). This allows users to disable plugins that are crashing or executing slowly.

Driven by by the USDIMAGING_ENABLE_PLUGINS environment variable.

USDIMAGING_API UsdImagingPrimAdapterSharedPtr ConstructAdapter ( TfToken const &  adapterKey)

Returns a new instance of the UsdImagingPrimAdapter that has been registered to handle the given adapterKey.

This key is either a prim typename or a key specified in UsdImagingAdapterKeyTokens. Returns NULL if no adapter was registered for this key.

USDIMAGING_API bool HasAdapter ( TfToken const &  adapterKey)

Returns true if an adapter has been registered to handle the given adapterKey.


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