unreal.GeometryCollection

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

Bases: unreal.Object

UGeometryCollectionObject (UObject)

UObject wrapper for the FGeometryCollection

C++ Source:

  • Module: GeometryCollectionEngine

  • File: GeometryCollectionObject.h

Editor Properties: (see get_editor_property/set_editor_property)

  • 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.

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

  • 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

  • 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.

  • 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)

  • 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

  • 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.

  • 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.

  • 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)

property collision_object_reduction_percentage

[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

[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

[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

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

Type

(bool)

property enable_remove_pieces_on_fracture

[Read-Only] Enable Remove Pieces on Fracture: Enable remove pieces on fracture

Type

(bool)

property geometry_source

[Read-Write] Geometry Source

Type

(Array(GeometryCollectionSource))

property implicit_type

[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 mass

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

Type

(float)

property mass_as_density

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

Type

(bool)

property max_cluster_level_set_resolution

[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

[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

[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

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

Type

(Vector2D)

property min_cluster_level_set_resolution

[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

[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

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

Type

(float)

property removal_duration

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

Type

(Vector2D)

property remove_on_max_sleep

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

Type

(bool)