connectableAPIBehavior.h File Reference

Include dependency graph for connectableAPIBehavior.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	UsdShadeConnectableAPIBehavior
	UsdShadeConnectableAPIBehavior defines the compatibilty and behavior UsdShadeConnectableAPIof when applied to a particular prim type. More...

Functions
template<class PrimType , class BehaviorType = UsdShadeConnectableAPIBehavior>
void	UsdShadeRegisterConnectableAPIBehavior ()
	Registers behavior to define connectability of attributes for PrimType. More...
USDSHADE_API void	UsdShadeRegisterConnectableAPIBehavior (const TfType &connectablePrimType, const std::shared_ptr< UsdShadeConnectableAPIBehavior > &behavior)
	Registers behavior to define connectability of attributes for PrimType. More...

Function Documentation

void UsdShadeRegisterConnectableAPIBehavior ( )

inline

Registers behavior to define connectability of attributes for PrimType.

Plugins should call this function in a TF_REGISTRY_FUNCTION. For example:

*  class MyBehavior : public UsdShadeConnectableAPIBehavior { ... }
*  
*  TF_REGISTRY_FUNCTION(UsdShadeConnectableAPI)
*  {
*      UsdShadeRegisterConnectableAPIBehavior<MyPrim, MyBehavior>();
*  }
*  

Plugins must also note that UsdShadeConnectableAPI behavior is implemented for a prim type in that type's schema definnition. For example:

*  class "MyPrim" (
*      ...
*      customData = {
*          dictionary extraPlugInfo = {
*              bool implementsUsdShadeConnectableAPIBehavior = true
*          }
*      }
*      ...
*  )
*  { ... }
*  

This allows the plugin system to discover this behavior dynamically and load the plugin if needed.

Definition at line 175 of file connectableAPIBehavior.h.

USDSHADE_API void UsdShadeRegisterConnectableAPIBehavior	(	const TfType &	connectablePrimType,
		const std::shared_ptr< UsdShadeConnectableAPIBehavior > &	behavior
	)

Registers behavior to define connectability of attributes for PrimType.