UInterchangeGenericPayloadInterface

Navigation

API > API/Plugins > API/Plugins/InterchangeImport

Payload interface implemented by translators that want to allow user code to provide different payload types to Interchange.

The USD translator uses this mechanism: A user plugin may implement a schema handler that can provide custom payload data, and also register a factory that can handle it. Without a mechanism such as this however, there would be no way of getting that payload data from the schema handler to the factory, as the translator would need to be also modified with a custom payload interface.

Instead, the USD translator already implements this interface, and the schema handler can provide a payload data class that derives UInterchangeGenericPayloadData, while the factory can try casting its received UInterchangeGenericPayloadData to the derived type.

Syntax

class UInterchangeGenericPayloadInterface : public UInterface  
Copy full snippet

class UInterchangeGenericPayloadInterface : public UInterface

Inheritance Hierarchy

• UObjectBase → UObjectBaseUtility → UObject → UInterface → UInterchangeGenericPayloadInterface