unreal.PVMeshBuilderParams

class unreal.PVMeshBuilderParams

Bases: StructBase

PVMesh Builder Params

C++ Source:

  • Plugin: ProceduralVegetationEditor

  • Module: ProceduralVegetation

  • File: PVMeshBuilder.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accuracy (int32): [Read-Write] Accuracy level for mesh reduction.

    Controls how closely the simplified mesh follows the original. It specifies number of iterations that are used to evaluate the curve reduction path. The more number of iterations the more accurate the reduction will be at the cost of processing power.

  • apply_profile_to_branches (bool): [Read-Write] Should the profile be applied to branches or just the trunk

  • displacement_bias (float): [Read-Write] Shifts the midpoint of displacement.

    Offsets the neutral level of the displacement map. Positive bias lifts the surface outward. Useful for correcting textures that displace unevenly or need centering.

  • displacement_generation_upper_limit (int32): [Read-Write] Controls which generations the displacement is applied on

    Controls which generations the displacement is applied on.

  • displacement_strength (float): [Read-Write] Intensity of displacement effect.

    Sets the overall strength of the displacement. Higher values exaggerate surface depth and detail, while lower values apply subtle variation. Use to balance realism with mesh stability.

  • displacement_texture (Texture2D): [Read-Write] Texture used to drive mesh displacement.

    Assigns the texture map that controls displacement. Bright and dark areas in the texture push or pull the mesh surface to create additional geometric detail such as bark roughness, grooves, or ridges.

    Only power of 2 textures with source texture formats (TSF_RGBA32F, TSF_RGBA16F, TSF_BGRA8, TSF_R32F, TSF_R16F, TSF_G8) are supported.

    For formats TSF_RGBA32F, TSF_RGBA16F and TSF_BGRA8 data from R channel is used.

  • displacement_uv_scale (Vector2f): [Read-Write] Controls tiling of displacement texture.

    Adjusts the repetition of the displacement texture across the mesh in U and V directions. Higher values increase tiling frequency (smaller details repeated more often), while lower values stretch the texture over a larger area.

  • ground_retention (float): [Read-Write] Preserves detail near ground regions.

    Adjusts retention for areas close to the base of the plant. Use higher values to keep root/ground transitions detailed.

  • ground_retention_gradient (PVFloatRamp): [Read-Write] Gradient for preserving ground-region detail.

    A ramp that modulates retention around base regions. Tune to keep roots/basal features while allowing simplification above.

  • hull_retention (float): [Read-Write] Strength of preserving the outer hull.

    Adjusts retention of the mesh silhouette during reduction. Higher values protect external shape; lower values allow more simplification.

  • hull_retention_gradient (PVFloatRamp): [Read-Write] Gradient for preserving outer hull detail.

    A ramp that varies outer-hull retention across the model. Use to keep silhouettes crisp where needed while simplifying elsewhere.

  • longest_segment_length (float): [Read-Write] Maximum allowed segment length.

    Caps segment length after simplification to maintain even geometry and prevent stretched polygons.

  • main_trunk_retention (float): [Read-Write] Preserves detail in the main trunk.

    Controls how much trunk geometry is retained during simplification. High values keep trunk smooth and detailed; low values reduce complexity.

  • main_trunk_retention_gradient (PVFloatRamp): [Read-Write] Gradient controlling trunk detail retention.

    Varies trunk retention via a ramp. Useful to preserve key trunk regions while simplifying others.

  • material_settings (PVMaterialSettings): [Read-Write]

  • max_mesh_divisions (int32): [Read-Write] Maximum radial divisions.

    Upper limit for cross-section detail on trunks/branches. Balance with Min Divisions to control density across sizes.

  • min_mesh_divisions (int32): [Read-Write] Minimum radial divisions.

    The lowest polygon count around cross-sections. Higher values keep sections smooth; lower values produce blockier geometry with better performance.

  • override_material (bool): [Read-Write] Toggles between default and custom material settings.

    Default material setting is defined in Procedural Vegetation Preset.

    Custom material settings allow for editing.

  • plant_profile_fall_off (PVFloatRamp): [Read-Write] Gradient controlling how the profile shape is applied across the length of the trunk and branches

    Can be used to create a base where the trunk widens and transitions into main roots (Root Flare)

  • plant_profile_scale (float): [Read-Write] Scale of the profile applied

    Can be used to create a wider base in conjection with Profile Falloff

  • point_removal (float): [Read-Write] Removes small points to simplify the mesh.

    Points are used to define the tree structure and used as basis for generating the mesh. This does not remove points but reduces the points considered for mesh generation. The impact is dependent on Hull, Main Trunk, Ground and Scale Retention settings.

  • scale_retention (float): [Read-Write] Preserves detail relative to branch size.

    Retains more detail on larger/thicker structures and simplifies smaller ones to prioritize visually important geometry.

  • scale_retention_gradient (PVFloatRamp): [Read-Write] Gradient controlling size-based retention.

    Uses a ramp to vary how size-dependent retention is applied across the model. Keep large structures crisp while simplifying finer parts.

  • segment_reduction (float): [Read-Write] Controls how aggressively segments are reduced.

    Segments are created based on the number of points required to represent the shape of the plant. The algorithm tries to simplify the polyline by reducing the number of points required to represent it, while maintaining its overall shape. The impact is dependent on Hull, Main Trunk, Ground and Scale Retention settings. Higher values reduce edge count for lighter meshes; lower values preserve detail.

  • segment_retention_impact (float): [Read-Write] Control the impact of reduced segments based on other criteria

    Segment retention impact allows you to reintroduce points that have been reduced based on user defined criteria’s. See; Hull Retention, Ground Retention and Trunk Retention.

  • selected_plant_profile (str): [Read-Write] Select a profile (cross sectional shape) from predefined options

    None applies a simple circular cross sectional shape

  • shortest_segment_length (float): [Read-Write] Minimum allowed segment length.

    Segments shorter than this are merged or removed to avoid unnecessary fine detail that inflates polycount.