HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
UsdImagingAdapterRegistry Class Reference

#include <adapterRegistry.h>

+ Inheritance diagram for UsdImagingAdapterRegistry:

Public Types

using ApiSchemaAdapters = std::vector< UsdImagingAPISchemaAdapterSharedPtr >
 

Public Member Functions

USDIMAGING_API bool HasAdapter (TfToken const &adapterKey)
 
USDIMAGING_API
UsdImagingPrimAdapterSharedPtr 		ConstructAdapter (TfToken const &adapterKey)
 
USDIMAGING_API const
TfTokenVector & 		GetAdapterKeys ()
 
USDIMAGING_API bool HasAPISchemaAdapter (TfToken const &adapterKey)
 
USDIMAGING_API
UsdImagingAPISchemaAdapterSharedPtr 		ConstructAPISchemaAdapter (TfToken const &adapterKey)
 
USDIMAGING_API const
TfTokenVector & 		GetAPISchemaAdapterKeys ()
 
USDIMAGING_API ApiSchemaAdapters ConstructKeylessAPISchemaAdapters ()
 

Static Public Member Functions

static USDIMAGING_API bool AreExternalPluginsEnabled ()
 
static USDIMAGING_API
UsdImagingAdapterRegistry & 		GetInstance ()
 
- Static Public Member Functions inherited from TfSingleton< UsdImagingAdapterRegistry >
static UsdImagingAdapterRegistry & GetInstance ()
 
static bool CurrentlyExists ()
 
static void SetInstanceConstructed (UsdImagingAdapterRegistry &instance)
 
static void DeleteInstance ()
 

Friends

class TfSingleton< UsdImagingAdapterRegistry >
 

Detailed Description

Registry of PrimAdapter plug-ins. Note: this is a registry of adapter factories, and not adapter instances; we expect to store adapter instances (created via ConstructAdapter) with per-stage data.

Definition at line 62 of file adapterRegistry.h.

Member Typedef Documentation

using UsdImagingAdapterRegistry::ApiSchemaAdapters = std::vector<UsdImagingAPISchemaAdapterSharedPtr>

Definition at line 136 of file adapterRegistry.h.

Member Function Documentation

static USDIMAGING_API bool UsdImagingAdapterRegistry::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 UsdImagingAdapterRegistry::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 UsdImagingAPISchemaAdapterSharedPtr UsdImagingAdapterRegistry::ConstructAPISchemaAdapter ( TfToken const &  adapterKey)

Returns a new instance of the UsdImagingAPISchemaAdapter that has been registered to handle the given adapterKey. Returns NULL if no adapter was registered for this key.

USDIMAGING_API ApiSchemaAdapters UsdImagingAdapterRegistry::ConstructKeylessAPISchemaAdapters ( )

Constructs instances of "keyless" api schema adapters which are intended to run for every prim.

USDIMAGING_API const TfTokenVector& UsdImagingAdapterRegistry::GetAdapterKeys ( )

Returns the set of adapter keys this class responds to; i.e. the set of usd prim types for which we've registered a prim adapter.

USDIMAGING_API const TfTokenVector& UsdImagingAdapterRegistry::GetAPISchemaAdapterKeys ( )

Returns the set of api schema adapter keys this class responds to; i.e. the set of usd api schema types for which we've registered an adapter.

static USDIMAGING_API UsdImagingAdapterRegistry& UsdImagingAdapterRegistry::GetInstance ( )
inlinestatic

Definition at line 97 of file adapterRegistry.h.

USDIMAGING_API bool UsdImagingAdapterRegistry::HasAdapter ( TfToken const &  adapterKey)

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

USDIMAGING_API bool UsdImagingAdapterRegistry::HasAPISchemaAdapter ( TfToken const &  adapterKey)

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

Friends And Related Function Documentation

friend class TfSingleton< UsdImagingAdapterRegistry >
friend

Definition at line 64 of file adapterRegistry.h.

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