unreal.GeometryCollection

class unreal.GeometryCollection(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: Object

UGeometryCollectionObject (UObject)

UObject wrapper for the FGeometryCollection

C++ Source:

  • Module: GeometryCollectionEngine

  • File: GeometryCollectionObject.h

Editor Properties: (see get_editor_property/set_editor_property)

  • auto_instance_meshes (Array[GeometryCollectionAutoInstanceMesh]): [Read-Write] Auto Instance Meshes: list of unique static mesh / materials pairs for auto instancing

  • cluster_connection_type (ClusterConnectionTypeEnum): [Read-Write] Cluster Connection Type

  • cluster_group_index (int32): [Read-Write] Cluster Group Index: Maximum level for cluster breaks.

  • collision_object_reduction_percentage (float): [Read-Write] Collision Object Reduction Percentage: * Resolution on the smallest axes for the level set. (def: 10) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

  • collision_particles_fraction (float): [Read-Write] Collision Particles Fraction: Number of particles on the triangulated surface to use for collisions. deprecated: This property is deprecated. Use the default SizeSpecificData instead.

  • collision_type (CollisionTypeEnum): [Read-Write] Collision Type: * CollisionType defines how to initialize the rigid collision structures. deprecated: This property is deprecated. Use the default SizeSpecificData instead.

  • connection_graph_bounds_filtering_margin (float): [Read-Write] Connection Graph Bounds Filtering Margin

  • damage_propagation_data (GeometryCollectionDamagePropagationData): [Read-Write] Damage Propagation Data: Data about how damage propagation shoudl behave.

  • damage_threshold (Array[float]): [Read-Write] Damage Threshold: Damage threshold for clusters at different levels.

  • dataflow (Dataflow): [Read-Write] Dataflow: Dataflow

  • embedded_geometry_exemplar (Array[GeometryCollectionEmbeddedExemplar]): [Read-Write] Embedded Geometry Exemplar: References for embedded geometry generation

  • enable_clustering (bool): [Read-Write] Enable Clustering

  • enable_nanite (bool): [Read-Write] Enable Nanite: Enable support for Nanite.

  • enable_remove_pieces_on_fracture (bool): [Read-Write] Enable Remove Pieces on Fracture: Enable remove pieces on fracture deprecated: Use remove on break feature instead ( Fracture editor tools ).

  • geometry_source (Array[GeometryCollectionSource]): [Read-Write] Geometry Source

  • implicit_type (ImplicitTypeEnum): [Read-Write] Implicit Type: * CollisionType defines how to initialize the rigid collision structures. deprecated: This property is deprecated. Use the default SizeSpecificData instead.

  • import_collision_from_source (bool): [Read-Write] Import Collision from Source: whether to import collision from the source asset

  • mass (float): [Read-Write] Mass: Total Mass of Collection. If density, units are in kg/m^3

  • mass_as_density (bool): [Read-Write] Mass as Density: Mass As Density, units are in kg/m^3

  • materials (Array[MaterialInterface]): [Read-Write] Materials

  • max_cluster_level (int32): [Read-Write] Max Cluster Level: Maximum level for cluster breaks.

  • max_cluster_level_set_resolution (int32): [Read-Write] Max Cluster Level Set Resolution: * Resolution on the smallest axes for the level set. (def: 10) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

  • max_level_set_resolution (int32): [Read-Write] Max Level Set Resolution: * Resolution on the smallest axes for the level set. (def: 10) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

  • maximum_collision_particles (int32): [Read-Write] Maximum Collision Particles: Max number of particles. deprecated: This property is deprecated. Use the default SizeSpecificData instead.

  • maximum_sleep_time (Vector2D): [Read-Write] Maximum Sleep Time: How long may the particle sleep before initiating removal (in seconds).

  • min_cluster_level_set_resolution (int32): [Read-Write] Min Cluster Level Set Resolution: * Resolution on the smallest axes for the level set. (def: 5) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

  • min_level_set_resolution (int32): [Read-Write] Min Level Set Resolution: * Resolution on the smallest axes for the level set. (def: 5) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

  • minimum_mass_clamp (float): [Read-Write] Minimum Mass Clamp: Smallest allowable mass (def:0.1)

  • per_cluster_only_damage_threshold (bool): [Read-Write] Per Cluster Only Damage Threshold: compatibility check, when true, only cluster compute damage from parameters and propagate to direct children when false, each child will compute it’s damage threshold allowing for more precise and intuitive destruction behavior

  • removal_duration (Vector2D): [Read-Write] Removal Duration: How long does the removal process take (in seconds).

  • remove_on_fracture_materials (Array[MaterialInterface]): [Read-Write] Remove on Fracture Materials: Materials relating to remove on fracture deprecated: Use remove on break feature instead ( Fracture editor tools ).

  • remove_on_max_sleep (bool): [Read-Write] Remove on Max Sleep: Remove particle from simulation and dissolve rendered geometry once sleep threshold has been exceeded.

  • root_proxy (SoftObjectPath): [Read-Write] Root Proxy: static mesh to use as a proxy for rendering until the geometry collection is broken

  • size_specific_data (Array[GeometryCollectionSizeSpecificData]): [Read-Write] Size Specific Data: * Size Specfic Data reflects the default geometry to bind to rigid bodies smaller * than the max size volume. This can also be empty to reflect no collision geometry * for the collection.

  • slow_moving_as_sleeping (bool): [Read-Write] Slow Moving as Sleeping: when on non-sleeping, slow moving pieces will be considered as sleeping, this helps removal of jittery but not really moving objects.

  • slow_moving_velocity_threshold (float): [Read-Write] Slow Moving Velocity Threshold: When slow moving detection is on, this defines the linear velocity thresholds in cm/s to consider the object as sleeping .

  • strip_on_cook (bool): [Read-Write] Strip on Cook: Strip unnecessary data from the Geometry Collection to keep the memory footprint as small as possible.

  • thumbnail_info (ThumbnailInfo): [Read-Only] Thumbnail Info: Information for thumbnail rendering

  • use_full_precision_u_vs (bool): [Read-Write] Use Full Precision UVs: Whether to use full precision UVs when rendering this geometry. (Does not apply to Nanite rendering)

  • use_size_specific_damage_threshold (bool): [Read-Write] Use Size Specific Damage Threshold: whether to use size specific damage threshold instead of level based ones ( see Size Specific Data array ).

property collision_object_reduction_percentage: float

[Read-Write] Collision Object Reduction Percentage: * Resolution on the smallest axes for the level set. (def: 10) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

Type:

(float)

property collision_particles_fraction: float

[Read-Write] Collision Particles Fraction: Number of particles on the triangulated surface to use for collisions. deprecated: This property is deprecated. Use the default SizeSpecificData instead.

Type:

(float)

property collision_type: CollisionTypeEnum

[Read-Write] Collision Type: * CollisionType defines how to initialize the rigid collision structures. deprecated: This property is deprecated. Use the default SizeSpecificData instead.

Type:

(CollisionTypeEnum)

property enable_nanite: bool

[Read-Only] Enable Nanite: Enable support for Nanite.

Type:

(bool)

property enable_remove_pieces_on_fracture: bool

[Read-Write] Enable Remove Pieces on Fracture: Enable remove pieces on fracture deprecated: Use remove on break feature instead ( Fracture editor tools ).

Type:

(bool)

property geometry_source: Array[GeometryCollectionSource]

[Read-Write] Geometry Source

Type:

(Array[GeometryCollectionSource])

property implicit_type: ImplicitTypeEnum

[Read-Write] Implicit Type: * CollisionType defines how to initialize the rigid collision structures. deprecated: This property is deprecated. Use the default SizeSpecificData instead.

Type:

(ImplicitTypeEnum)

property import_collision_from_source: bool

[Read-Only] Import Collision from Source: whether to import collision from the source asset

Type:

(bool)

property mass: float

[Read-Only] Mass: Total Mass of Collection. If density, units are in kg/m^3

Type:

(float)

property mass_as_density: bool

[Read-Only] Mass as Density: Mass As Density, units are in kg/m^3

Type:

(bool)

property max_cluster_level_set_resolution: int

[Read-Write] Max Cluster Level Set Resolution: * Resolution on the smallest axes for the level set. (def: 10) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

Type:

(int32)

property max_level_set_resolution: int

[Read-Write] Max Level Set Resolution: * Resolution on the smallest axes for the level set. (def: 10) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

Type:

(int32)

property maximum_collision_particles: int

[Read-Write] Maximum Collision Particles: Max number of particles. deprecated: This property is deprecated. Use the default SizeSpecificData instead.

Type:

(int32)

property maximum_sleep_time: Vector2D

[Read-Only] Maximum Sleep Time: How long may the particle sleep before initiating removal (in seconds).

Type:

(Vector2D)

property min_cluster_level_set_resolution: int

[Read-Write] Min Cluster Level Set Resolution: * Resolution on the smallest axes for the level set. (def: 5) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

Type:

(int32)

property min_level_set_resolution: int

[Read-Write] Min Level Set Resolution: * Resolution on the smallest axes for the level set. (def: 5) deprecated: This property is deprecated. Use the default SizeSpecificData instead.

Type:

(int32)

property minimum_mass_clamp: float

[Read-Only] Minimum Mass Clamp: Smallest allowable mass (def:0.1)

Type:

(float)

property removal_duration: Vector2D

[Read-Only] Removal Duration: How long does the removal process take (in seconds).

Type:

(Vector2D)

property remove_on_fracture_materials: Array[MaterialInterface]

[Read-Write] Remove on Fracture Materials: Materials relating to remove on fracture deprecated: Use remove on break feature instead ( Fracture editor tools ).

Type:

(Array[MaterialInterface])

property remove_on_max_sleep: bool

[Read-Only] Remove on Max Sleep: Remove particle from simulation and dissolve rendered geometry once sleep threshold has been exceeded.

Type:

(bool)

property root_proxy: SoftObjectPath

[Read-Write] Root Proxy: static mesh to use as a proxy for rendering until the geometry collection is broken

Type:

(SoftObjectPath)

property slow_moving_as_sleeping: bool

[Read-Only] Slow Moving as Sleeping: when on non-sleeping, slow moving pieces will be considered as sleeping, this helps removal of jittery but not really moving objects.

Type:

(bool)

property slow_moving_velocity_threshold: float

[Read-Only] Slow Moving Velocity Threshold: When slow moving detection is on, this defines the linear velocity thresholds in cm/s to consider the object as sleeping .

Type:

(float)