3ds Max USD API Reference
Loading...
Searching...
No Matches
MaxUsdExportChaserRegistry Class Reference

Registry for chaser plugins. More...

#include <ExportChaserRegistry.h>

Inheritance diagram for MaxUsdExportChaserRegistry:

Classes

struct  ChaserInfo
 All the information registered for a chaser. More...
 
class  FactoryContext
 Holds data that can be accessed when constructing a MaxUsdExportChaser object. More...
 

Public Types

typedef std::function< MaxUsdExportChaser *(const FactoryContext &)> FactoryFn
 

Public Member Functions

MaxUSDAPI bool RegisterFactory (const std::string &chaser, const std::string &niceName, const std::string &description, FactoryFn fn, bool fromPython=false)
 Register a chaser factory. More...
 

Static Public Member Functions

static const ChaserInfoGetChaserInfo (const TfToken &chaser)
 Gets the chaser information.
 
static MaxUSDAPI MaxUsdExportChaserRefPtr Create (const std::string &name, const FactoryContext &context)
 Creates a chaser using the factoring registered to name.
 
static MaxUSDAPI TfTokenVector GetAllRegisteredChasers ()
 Returns the names of all registered chasers.
 
static MaxUSDAPI MaxUsdExportChaserRegistryGetInstance ()
 

Friends

class TfSingleton< MaxUsdExportChaserRegistry >
 

Detailed Description

Registry for chaser plugins.

We allow sites to register new chaser scripts that can be enabled on export.

Use PXR_MAXUSD_DEFINE_CHASER_FACTORY(name, ctx) to register a new chaser.

Unfortunately, these are only available through the command/python interface and not yet exposed in the translator interface.

Member Function Documentation

◆ RegisterFactory()

MaxUSDAPI bool MaxUsdExportChaserRegistry::RegisterFactory ( const std::string &  chaser,
const std::string &  niceName,
const std::string &  description,
FactoryFn  fn,
bool  fromPython = false 
)

Register a chaser factory.

Please use the PXR_MAXUSD_DEFINE_CHASER_FACTORY instead of calling this directly.

Parameters
chaserthe referenced name in the chaser option list on export
niceNameis the name displayed in the export options dialog.
descriptionis displayed as a tooltip in the export options dialog.

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