Settings

class omni.graph.core.Settings(VERSION: str = '/persistent/omnigraph/settingsVersion', DEFAULT_EVALUATOR: str = '/persistent/omnigraph/defaultEvaluator', UPDATE_MESH_TO_HYDRA: str = '/persistent/omnigraph/updateMeshPointsToHydra', USE_DYNAMIC_SCHEDULER: str = '/persistent/omnigraph/useDynamicScheduler', REALM_ENABLED: str = '/persistent/omnigraph/realmEnabled', CACHED_CONNECTIONS_IN_FILE: str = '/persistent/omnigraph/useCachedConnectionsForFileLoad', PLAY_COMPUTE_GRAPH: str = '/app/player/playComputegraph', OPTIMIZE_GENERATED_PYTHON: str = '/persistent/omnigraph/generator/pyOptimize', ENABLE_PATH_CHANGED_CALLBACK: str = '/persistent/omnigraph/enablePathChangedCallback', DEPRECATIONS_ARE_ERRORS: str = '/persistent/omnigraph/deprecationsAreErrors')

Bases: object

Class that packages up all of the OmniGraph settings handling into a common location. The settings themselves are handled through the Carbonite settings ABI, this just provides a nicer and more focused interface. Values here should also be reflected in the C++ OmniGraphSettings class.

Methods

`__init__`([VERSION, DEFAULT_EVALUATOR, ...])
`generator_settings`()	Return the generator settings object corresponding to the current carb settings
`temporary`(setting_name[, setting_value])	Generator to temporarily use a new setting value

Attributes

`ALLOW_IMPLICIT_GRAPH`
`CACHED_CONNECTIONS_IN_FILE`	Use USD metadata with connection information as a cache to speed up file load
`DEFAULT_EVALUATOR`	Default evaluator type for new graphs
`DEPRECATIONS_ARE_ERRORS`	Modify deprecation paths to raise errors or exceptions instead of logging warnings.
`DISABLE_INFO_NOTICE_HANDLING_IN_PLAYBACK`	Disable all processing of info-only notices by OG.
`DISABLE_PRIM_NODES_SETTING`
`ENABLE_LEGACY_GRAPH_EDITOR`
`ENABLE_LEGACY_PRIM_CONNECTIONS`
`ENABLE_PATH_CHANGED_CALLBACK`	Enable the deprecated Node.pathChangedCallback.
`ENABLE_USD_IN_PRERENDER`
`OPTIMIZE_GENERATED_PYTHON`	Optimize the Python code being output by the node generator
`PLAY_COMPUTE_GRAPH`	Evaluate OmniGraph when the Kit 'Play' button is pressed
`REALM_ENABLED`	Enable use of Realm for scheduling
`UPDATE_MESH_TO_HYDRA`	Update mesh points directly to Hydra
`UPDATE_TO_USD`
`USE_DYNAMIC_SCHEDULER`	Force use of the dynamic scheduler
`USE_LEGACY_PIPELINE`
`USE_SCHEMA_PRIMS`
`VERSION`	Version number of these settings

__init__(VERSION: str = '/persistent/omnigraph/settingsVersion', DEFAULT_EVALUATOR: str = '/persistent/omnigraph/defaultEvaluator', UPDATE_MESH_TO_HYDRA: str = '/persistent/omnigraph/updateMeshPointsToHydra', USE_DYNAMIC_SCHEDULER: str = '/persistent/omnigraph/useDynamicScheduler', REALM_ENABLED: str = '/persistent/omnigraph/realmEnabled', CACHED_CONNECTIONS_IN_FILE: str = '/persistent/omnigraph/useCachedConnectionsForFileLoad', PLAY_COMPUTE_GRAPH: str = '/app/player/playComputegraph', OPTIMIZE_GENERATED_PYTHON: str = '/persistent/omnigraph/generator/pyOptimize', ENABLE_PATH_CHANGED_CALLBACK: str = '/persistent/omnigraph/enablePathChangedCallback', DEPRECATIONS_ARE_ERRORS: str = '/persistent/omnigraph/deprecationsAreErrors') → None

static generator_settings() → omni.graph.tools._impl.node_generator.utils.Settings: Return the generator settings object corresponding to the current carb settings

static temporary(setting_name: Union[str, List[Tuple[str, Any]], Dict[str, Any]], setting_value: Any = None)

Generator to temporarily use a new setting value

Parameters

setting_name – A string containing the path to the setting (e.g. “/persistent/omnigraph/defaultEvaluator”) or a list of tuples containing setting name and value pairs.
setting_value – New value for the setting. ‘None’ is not a valid setting value and will generate a warning. Ignored if ‘setting_name’ is a list.

If a setting does not yet exist it will be created at context entry and removed at context exit.

Examples

with og.Settings.temporary(og.Settings.DEFAULT_EVALUATOR, “pull”):: do_something_that_needs_lazy_evaluation()
with og.Settings.temporary([(“/MySettings/debug”, True), (og.Settings.DEFAULT_EVALUATOR, “execution”)]):: do_something_that_needs_action_graph()

CACHED_CONNECTIONS_IN_FILE: str = '/persistent/omnigraph/useCachedConnectionsForFileLoad': Use USD metadata with connection information as a cache to speed up file load

DEFAULT_EVALUATOR: str = '/persistent/omnigraph/defaultEvaluator': Default evaluator type for new graphs

DEPRECATIONS_ARE_ERRORS: str = '/persistent/omnigraph/deprecationsAreErrors': Modify deprecation paths to raise errors or exceptions instead of logging warnings.

DISABLE_INFO_NOTICE_HANDLING_IN_PLAYBACK = '/persistent/omnigraph/disableInfoNoticeHandlingInPlayback': Disable all processing of info-only notices by OG. This is an optimization for applications which do not require any triggering of OG via USD (value_changed and path_changed callbacks, lazy-graph etc

ENABLE_PATH_CHANGED_CALLBACK: str = '/persistent/omnigraph/enablePathChangedCallback': Enable the deprecated Node.pathChangedCallback. This will affect performance.

OPTIMIZE_GENERATED_PYTHON: str = '/persistent/omnigraph/generator/pyOptimize': Optimize the Python code being output by the node generator

PLAY_COMPUTE_GRAPH: str = '/app/player/playComputegraph': Evaluate OmniGraph when the Kit ‘Play’ button is pressed

REALM_ENABLED: str = '/persistent/omnigraph/realmEnabled': Enable use of Realm for scheduling

UPDATE_MESH_TO_HYDRA: str = '/persistent/omnigraph/updateMeshPointsToHydra': Update mesh points directly to Hydra

USE_DYNAMIC_SCHEDULER: str = '/persistent/omnigraph/useDynamicScheduler': Force use of the dynamic scheduler

VERSION: str = '/persistent/omnigraph/settingsVersion': Version number of these settings