unreal.RuntimeMesh

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

Bases: unreal.StaticMesh

Class deriving from UStaticMesh to allow the cooking of collision meshes at runtime To do so, bAllowCPUAccess must be true AND the metod GetWorld() must return a valid world

C++ Source:

  • Plugin: DatasmithRuntime

  • Module: DatasmithRuntime

  • File: DatasmithRuntimeUtils.h

Editor Properties: (see get_editor_property/set_editor_property)

  • allow_cpu_access (bool): [Read-Write] Allow CPUAccess: If true, will keep geometry data CPU-accessible in cooked builds, rather than uploading to GPU memory and releasing it from CPU memory. This is required if you wish to access StaticMesh geometry data on the CPU at runtime in cooked builds (e.g. to convert StaticMesh to ProceduralMeshComponent)

  • asset_import_data (AssetImportData): [Read-Write] Asset Import Data: Importing data and options used for this mesh

  • asset_user_data (Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the asset

  • body_setup (BodySetup): [Read-Write] Body Setup

  • complex_collision_mesh (StaticMesh): [Read-Write] Complex Collision Mesh

  • customized_collision (bool): [Read-Write] Customized Collision: If the user has modified collision in any way or has custom collision imported. Used for determining if to auto generate collision on import

  • distance_field_self_shadow_bias (float): [Read-Write] Distance Field Self Shadow Bias: Useful for reducing self shadowing from distance field methods when using world position offset to animate the mesh’s vertices.

  • generate_mesh_distance_field (bool): [Read-Write] Generate Mesh Distance Field: Whether to generate a distance field for this mesh, which can be used by DistanceField Indirect Shadows. This is ignored if the project’s ‘Generate Mesh Distance Fields’ setting is enabled.

  • global_force_mip_levels_to_be_resident (bool): [Read-Write] Global Force Mip Levels to be Resident: Global and serialized version of ForceMiplevelsToBeResident.

  • has_navigation_data (bool): [Read-Write] Has Navigation Data: If true, mesh will have NavCollision property with additional data for navmesh generation and usage.

    Set to false for distant meshes (always outside navigation bounds) to save memory on collision data.

  • light_map_coordinate_index (int32): [Read-Write] Light Map Coordinate Index: The light map coordinate index

  • light_map_resolution (int32): [Read-Write] Light Map Resolution: The light map resolution

  • lod_for_collision (int32): [Read-Write] LODFor Collision: Specifies which mesh LOD to use for complex (per-poly) collision. Sometimes it can be desirable to use a lower poly representation for collision to reduce memory usage, improve performance and behaviour. Collision representation does not change based on distance to camera.

  • lod_group (Name): [Read-Write] LODGroup: The LOD group to which this mesh belongs.

  • nanite_settings (MeshNaniteSettings): [Read-Write] Nanite Settings: Settings related to building Nanite data.

  • nav_collision (NavCollisionBase): [Read-Only] Nav Collision

  • negative_bounds_extension (Vector): [Read-Write] Negative Bounds Extension

  • never_stream (bool): [Read-Write] Never Stream

  • num_cinematic_mip_levels (int32): [Read-Write] Num Cinematic Mip Levels: Number of mip-levels to use for cinematic quality.

  • positive_bounds_extension (Vector): [Read-Write] Positive Bounds Extension

  • static_materials (Array(StaticMaterial)): [Read-Write] Static Materials

  • support_gpu_uniformly_distributed_sampling (bool): [Read-Write] Support Gpu Uniformly Distributed Sampling: If true, a GPU buffer containing required data for uniform mesh surface sampling will be created at load time. It is created from the cpu data so bSupportUniformlyDistributedSampling is also required to be true.

  • support_physical_material_masks (bool): [Read-Write] Support Physical Material Masks: If true, complex collision data will store UVs and face remap table for use when performing PhysicalMaterialMask lookups in cooked builds. Note the increased memory cost for this functionality.

  • support_ray_tracing (bool): [Read-Write] Support Ray Tracing: If true, a ray tracing acceleration structure will be built for this mesh and it may be used in ray tracing effects

  • support_uniformly_distributed_sampling (bool): [Read-Write] Support Uniformly Distributed Sampling: Mesh supports uniformly distributed sampling in constant time. Memory cost is 8 bytes per triangle. Example usage is uniform spawning of particles.

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