unreal.SchemaHandlerEntry

class unreal.SchemaHandlerEntry(handler_name: str = '', enabled: bool = False, schema_name: str = '', default_render_contexts: None = [], allow_custom_render_contexts: bool = False, custom_render_contexts: None = [])

Bases: StructBase

Represents a registered schema handler of a particular type.

This class is used instead of directly tracking FSchemaHandlerGenerators in order to allow programmatically inspecting and manipulating the registered persistent handler information without repeatedly instantiating handlers.

It’s a USTRUCT and kept in a separate file as it’s used by UInterchangeUsdTranslatorSettings in order to track custom schema handler settings (like ordering, which is enabled, etc.)

C++ Source:

  • Plugin: InterchangeOpenUSD

  • Module: InterchangeOpenUSDImport

  • File: SchemaHandlerEntry.h

Editor Properties: (see get_editor_property/set_editor_property)

  • allow_custom_render_contexts (bool): [Read-Write] If true, it means the handler allows the user to manually specify which render contexts to parse (e.g. the default ‘universal’ handler does this). If false, it means the handler is hard-coded to only look for a particular render context (e.g. the default MaterialX handler does this).

  • custom_render_contexts (Array[str]): [Read-Write] The full list of custom render contexts that this handler should try parsing. This is only used whenever bAllowCustomRenderContexts is enabled. This value is initialized with the value of DefaultRenderContexts within FSchemaHandlerRegistry::Register.

  • default_render_contexts (Array[str]): [Read-Write] For material schema handlers, we also hoist the render contexts the handler supports here, to be visible on the UI

  • enabled (bool): [Read-Write]

  • handler_name (str): [Read-Write]

  • schema_name (str): [Read-Write]

property allow_custom_render_contexts: bool

[Read-Write] If true, it means the handler allows the user to manually specify which render contexts to parse (e.g. the default ‘universal’ handler does this). If false, it means the handler is hard-coded to only look for a particular render context (e.g. the default MaterialX handler does this).

Type:

(bool)

property custom_render_contexts: None

[Read-Write] The full list of custom render contexts that this handler should try parsing. This is only used whenever bAllowCustomRenderContexts is enabled. This value is initialized with the value of DefaultRenderContexts within FSchemaHandlerRegistry::Register.

Type:

(Array[str])

property default_render_contexts: None

[Read-Only] For material schema handlers, we also hoist the render contexts the handler supports here, to be visible on the UI

Type:

(Array[str])

property enabled: bool

[Read-Write]

Type:

(bool)

property handler_name: str

[Read-Only]

Type:

(str)

property schema_name: str

[Read-Only]

Type:

(str)