unreal.GeometryCollectionLibrary

class unreal.GeometryCollectionLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Blueprint library for Geometry Collections.

C++ Source:

  • Module: GeometryCollectionEngine

  • File: GeometryCollectionBlueprintLibrary.h

classmethod add_geometry_collections_to_blueprint(blueprint, collections) → bool

Add Geometry Collections to Blueprint

Parameters:
Return type:

bool

classmethod set_custom_depth_stencil(geometry_collection_component, enable, custom_stencil_value) → None

Specify custom depth and a value to write during the custom depth pass for all instances associated with a geometry collection. This assumes that the geometry collection is using a custom renderer that supports IGeometryCollectionCustomDataInterface.

Parameters:

  • geometry_collection_component (GeometryCollectionComponent) – The Geometry Collection Component that we want to set custom depth data on.

  • enable (bool) – Enable or disable custom depth writing.

  • custom_stencil_value (int32) – The value which will be written to the stencil buffer during the custom depth pass if bEnable is true.

classmethod set_custom_instance_data_by_index(geometry_collection_component, custom_data_index, custom_data_value) → None

Set a custom instance data value for all instances associated with a geometry collection. This assumes that the geometry collection is using a custom renderer that supports IGeometryCollectionCustomDataInterface.

Parameters:

  • geometry_collection_component (GeometryCollectionComponent) – The Geometry Collection Component that we want to set custom instance data on.

  • custom_data_index (int32) – The index of the custom instance data slot that we want to set.

  • custom_data_value (float) – The value to set to the custom instance data slot.

classmethod set_custom_instance_data_by_name(geometry_collection_component, custom_data_name, custom_data_value) → None

Set a custom instance data value for all instances associated with a geometry collection. This assumes that the geometry collection is using a custom renderer that supports IGeometryCollectionCustomDataInterface.

Parameters:

  • geometry_collection_component (GeometryCollectionComponent) – The Geometry Collection Component that we want to set custom instance data on.

  • custom_data_name (Name) – The name of the custom instance data slot that we want to set.

  • custom_data_value (float) – The value to set to the custom instance data slot.

classmethod set_ism_pool_custom_instance_data(geometry_collection_component, custom_data_index, custom_data_value) → None

Set ISMPool Custom Instance Data deprecated: Use SetCustomInstanceDataByIndex() instead

Parameters: