unreal.DatasmithDataPrepFilterLibrary

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

Bases: unreal.BlueprintFunctionLibrary

Datasmith Data Prep Filter Library

C++ Source:

  • Plugin: DatasmithDataPrepEditor
  • Module: DatasmithDataPrepLibraries
  • File: DatasmithDataPrepFilterLibrary.h
classmethod filter_by_class(target_array, object_class) -> Array(Object)

Filter the array based on the Object’s class.

Parameters:
  • target_array (Array(Object)) – Array of Object to filter. The array will not change.
  • object_class (type(Class)) – The Class of the object.
Returns:

The filtered list.

Return type:

Array(Object)

classmethod filter_by_metadata(target_array, key, value, value_match=EditorScriptingStringMatchType.CONTAINS) -> Array(Object)

Filter the array based on the metadata key and value.

Parameters:
  • target_array (Array(Object)) – Array of Object to filter. The array will not change.
  • key (Name) – The key to filter with.
  • value (str) – An optional value to filter with.
  • value_match (EditorScriptingStringMatchType) – Contains the Value OR matches with the wildcard *? OR exactly the same value.
Returns:

The filtered list.

Return type:

Array(Object)

classmethod filter_by_name(target_array, name_sub_string, string_match=EditorScriptingStringMatchType.CONTAINS) -> Array(Object)

Filter the array based on the Object name.

Parameters:
  • target_array (Array(Object)) – Array of Object to filter. The array will not change.
  • name_sub_string (str) – The name to filter with.
  • string_match (EditorScriptingStringMatchType) – Contains the NameSubString OR matches with the wildcard *? OR exactly the same value.
Returns:

The filtered list.

Return type:

Array(Object)

classmethod filter_by_size(target_array, size_source, filter_mode, threshold) -> Array(Object)

Filter the array based on the geometry size.

Parameters:
  • target_array (Array(Object)) – Array of Actors or StaticMeshes to filter. The array will not change.
  • size_source (DataPrepSizeSource) – The reference dimension
  • filter_mode (DataPrepSizeFilterMode) – How to compare the object size with the threshold
  • threshold (float) – Limit value
Returns:

The filtered list.

Return type:

Array(Object)

classmethod filter_by_tag(target_array, tag) -> Array(Actor)

Filter the array based on a tag.

Parameters:
  • target_array (Array(Actor)) – Array of Actors to filter. The array will not change.
  • tag (Name) – The tag to filter with.
Returns:

The filtered list.

Return type:

Array(Actor)