unreal.DataprepEditingOperation

class unreal.DataprepEditingOperation(outer=None, name='None')

Bases: unreal.DataprepOperation

Base class for all Dataprep editing operations Dataprep editing operations act on a set of input obejcts and can modify their properties, but also can create new objects or delete existing ones (like assets and actors), based on the information they receive as an input

C++ Source:

• Plugin: DataprepEditor

• Module: DataprepCore

• File: DataprepOperation.h

add_asset(asset, asset_name) → Object

DUplicate and add an asset to the Dataprep’s and action’s working set

Parameters

• asset (Object) – If not null, the asset will be duplicated

• asset_name (str) – Name of the asset to create. Name collision will be checked and fixed before naming the asset

Returns

The asset newly created

Return type

Object

create_actor(actor_class, actor_name) → Actor

Add an actor to the Dataprep’s transient world and action’s working set

Parameters

• actor_class (type(Class)) – Class of the actor to create

• actor_name (str) – Name of the actor to create. Name collision will be performed before naming the asset

Returns

The actor newly created

Return type

Actor

create_asset(asset_class, asset_name) → Object

Create and add an asset to the Dataprep’s and action’s working set

Parameters

• asset_class (type(Class)) – If Asset is null, an asset of the given class will be returned

• asset_name (str) – Name of the asset to create. Name collision will be checked and fixed before naming the asset

Returns

The asset newly created

Return type

Object

delete_object(objects) → None

Delete an object from the Dataprep’s working set remark: The deletion of the object is deferred. However, if the object is not an asset, it is removed from the Dataprep’s transient world. If the object is an asset, it is moved to the transient package, no action is taken to clean up any object referencing this asset. remark: After execution, the object is not accessible by any subsequent operation in the Dataprep’s pipeline.

Parameters

objects (Object) –

delete_objects(objects) → None

Delete an array of objects from the Dataprep’s and action’s working set remark: The deletion of the object is deferred. However, if the object is not an asset, it is removed from the Dataprep’s transient world. If the object is an asset, it is moved to the transient package, no action is taken to clean up any object referencing this asset. remark: After execution, the object is not accessible by any subsequent operation in the Dataprep’s pipeline.

Parameters

objects (Array(Object)) – The array of objects to delete

remove_object(object, local_context=False) → None

Remove an object from the Dataprep’s and/or action’s working set

Parameters

• object (Object) – Object to be removed from the working set

• local_context (bool) – If set to true, the object is removed from the current working set. The object will not be accessible to any subsequent operation using the current context. If set to false, the object is removed from the Dataprep’s working set. The object will not be accessible to any subsequent operation in the Dataprep’s pipeline.

remove_objects(objects, local_context=False) → None

Remove an array of objects from the Dataprep’s and/or action’s working set

Parameters

• objects (Array(Object)) – An array of objects to be removed from the working set

• local_context (bool) – If set to true, the object is removed from the current working set. The object will not be accessible to any subsequent operation using the current context. If set to false, the object is removed from the Dataprep’s working set. The object will not be accessible to any subsequent operation in the Dataprep’s pipeline.