IBundleChanges

class omni.graph.core.IBundleChanges

Bases: _IBundleChanges

Interface for monitoring and handling changes in bundles and attributes.

The IBundleChanges_abi is an interface that provides methods for checking whether bundles and attributes have been modified, and cleaning them if they have been modified. This is particularly useful in scenarios where it’s crucial to track changes and maintain the state of bundles and attributes.

This interface provides several methods for checking and cleaning modifications, each catering to different use cases such as handling single bundles, multiple bundles, attributes, or specific attributes of a single bundle.

The methods of this interface return a BundleChangeType enumeration that indicates whether the checked entity (bundle or attribute) has been modified.

Methods

__init__(*args, **kwargs)	Overloaded function.
activate_change_tracking(*args, **kwargs)	Overloaded function.
clear_changes(self)	Clears all recorded changes.
create(arg0)
deactivate_change_tracking(*args, **kwargs)	Overloaded function.
get_change(*args, **kwargs)	Overloaded function.
get_changes(*args, **kwargs)	Overloaded function.

__init__(*args, **kwargs)

Overloaded function.

1. __init__(self: omni.graph.core._omni_graph_core.IBundleChanges, arg0: omni.core._core.IObject) -> None

2. __init__(self: omni.graph.core._omni_graph_core.IBundleChanges) -> None

activate_change_tracking(*args, **kwargs)

Overloaded function.

1. activate_change_tracking(self: omni.graph.core._omni_graph_core.IBundleChanges, handle: omni::graph::core::BundleHandle) -> int

@brief Activate tracking for specific bundle on its attributes and children. @param handle to the specific bundles to enable change tracking. @return An omni::core::Result indicating the success of the operation.

2. activate_change_tracking(self: omni.graph.core._omni_graph_core.IBundleChanges, bundle: omni.graph.core._omni_graph_core.IBundle2) -> None

   Activates the change tracking system for a bundle.

   This method controls the change tracking system of a bundle. It’s only applicable for read-write bundles.

   Args:

   bundle: A bundle to activate change tracking system for.

clear_changes(

self: omni.graph.core._omni_graph_core._IBundleChanges,

) → int

Clears all recorded changes.

This method is used to clear or reset all the recorded changes of the bundles and attributes. It can be used when the changes have been processed and need to be discarded.

An omni::core::Result indicating the success of the operation.

static create(

arg0: omni::graph::core::Py_GraphContext,

) → omni.graph.core._omni_graph_core.IBundleChanges

deactivate_change_tracking(*args, **kwargs)

Overloaded function.

1. deactivate_change_tracking(self: omni.graph.core._omni_graph_core.IBundleChanges, handle: omni::graph::core::BundleHandle) -> int

@brief Deactivate tracking for specific bundle on its attributes and children. @param handle to the specific bundles to enable change tracking. @return An omni::core::Result indicating the success of the operation.

2. deactivate_change_tracking(self: omni.graph.core._omni_graph_core.IBundleChanges, bundle: omni.graph.core._omni_graph_core.IBundle2) -> None

   Deactivates the change tracking system for a bundle.

   This method controls the change tracking system of a bundle. It’s only applicable for read-write bundles.

   Args:

   bundle: A bundle to deactivate change tracking system for.

get_change(*args, **kwargs)

Overloaded function.

1. get_change(self: omni.graph.core._omni_graph_core.IBundleChanges, bundle: omni.graph.core._omni_graph_core.IConstBundle2) -> omni.graph.core._omni_graph_core.BundleChangeType

   Retrieves the change status of a list of bundles.

   This method is used to check if any of the provided bundles or their contents have been modified.

   Args:

   bundles: A list of the bundles to check for modifications.

   Returns:

   list[omni.graph.core.BundleChangeType]: A list filled with BundleChangeType values for each bundle.

2. get_change(self: omni.graph.core._omni_graph_core.IBundleChanges, attribute: omni::graph::core::Py_AttributeData) -> omni.graph.core._omni_graph_core.BundleChangeType

   Retrieves the change status of a specific attribute.

   This method is used to check if a specific attribute has been modified.

   Args:

   attribute: The specific attribute to check for modifications.

   Returns:

   omni.graph.core.BundleChangeType: A BundleChangeType value indicating the type of change (if any) that has occurred to the attribute.

get_changes(*args, **kwargs)

Overloaded function.

1. get_changes(self: omni.graph.core._omni_graph_core.IBundleChanges, bundles: List[omni.graph.core._omni_graph_core.IConstBundle2]) -> List[omni.graph.core._omni_graph_core.BundleChangeType]

   Retrieves the change status of a list of bundles.

   This method is used to check if any of the bundles in the provided list or their contents have been modified.

   Args:

   bundles: A list of the bundles to check for modifications.

   Returns:

   list[omni.graph.core.BundleChangeType]: A list filled with BundleChangeType values for each bundle.

2. get_changes(self: omni.graph.core._omni_graph_core.IBundleChanges, attributes: List[omni::graph::core::Py_AttributeData]) -> List[omni.graph.core._omni_graph_core.BundleChangeType]

   Retrieves the change status of a list of attributes.

   This method is used to check if any of the attributes in the provided list have been modified.

   Args:

   attributes: A list of attributes to check for modifications.

   Returns:

   list[omni.graph.core.BundleChangeType]: A list filled with BundleChangeType values for each attribute.

3. get_changes(self: omni.graph.core._omni_graph_core.IBundleChanges, entries: sequence) -> List[omni.graph.core._omni_graph_core.BundleChangeType]

   Retrieves the change status for a list of bundles and attributes.

   This method is used to check if any of the bundles or attributes in the provided list have been modified. If an entry in the list is neither a bundle nor an attribute, its change status will be marked as None.

   Args:

   entries: A list of bundles and attributes to check for modifications.

   Returns:

   list[omni.graph.core.BundleChangeType]: A list filled with BundleChangeType values for each entry in the provided list.