unreal.PVFoliageDistributorSettings

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

Bases: PVBaseSettings

PVFoliage Distributor Settings

C++ Source:

  • Plugin: ProceduralVegetationEditor

  • Module: ProceduralVegetation

  • File: PVFoliageDistributorSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • axil_angle (float): [Read-Write] Base tilt from the parent axis

    Sets the base axil angle in degrees—the tilt of the instance relative to the parent branch’s direction. Acts as the lower bound when used with a ramp; higher values tilt foliage further away from the branch axis.

  • axil_angle_ramp (PVFloatRamp): [Read-Write] Ramp that varies the axil angle across the height of the plant

    Its output is remapped to an angle range defined by AxilAngle and AxilAngleRampUpperValue, modulated by AxilAngleRampEffect.

  • axil_angle_ramp_effect (float): [Read-Write] Adjusts this parameter for finer control.

    Defines the upper axil angle reached when AxilAngleRamp evaluates to 1. Together with AxilAngle, it forms the min–max range for ramp-driven orientation.

  • axil_angle_ramp_upper_value (float): [Read-Write] Max angle used when the ramp

    Provides detailed control over this parameter to balance visual quality and performance. Valid values: 0.0–90.0.

  • base_scale (float): [Read-Write] Default size multiplier for placed foliage

    Sets the base uniform scale applied to each instance before randomness and ramps are considered. Increase to enlarge all instances proportionally; decrease for smaller foliage. Final size still respects Min/Max limits.

  • branch_scale_impact (float): [Read-Write] Impact of branch size on foliage size

    The size of the foliage being scattered will be chosen in relation to the physical size of the branch it is distributed on. The largest branches will be distributed the largest foliage pieces.

  • break_debugger (bool): [Read-Write] If a debugger is attached, a breakpoint will be triggered in the execution code to enable debugging. Only applies when inspecting a debug object. Transient and Editor-only.

  • category (Text): [Read-Write]

  • debug (bool): [Read-Write]

  • debug_buffer_size (int32): [Read-Write] Size (in number of floats) of the shader debug print buffer.

  • debug_settings (PCGDebugVisualizationSettings): [Read-Write]

  • debug_visualization_settings (PVDebugSettings): [Read-Write]

  • description (Text): [Read-Write]

  • determinism_settings (PCGDeterminismSettings): [Read-Write]

  • dump_cooked_hlsl (bool): [Read-Write] Dump the cooked HLSL into the log after it is generated.

  • dump_data_descriptions (bool): [Read-Write] Dump the data descriptions of input/output pins to the log.

  • enabled (bool): [Read-Write]

  • ethylene_threshold (float): [Read-Write] Threshold controlling foliage release based on an ethylene-like signal.

    Higher Threshold → more buds/branches retained, making the plant denser and bushier. Lower Threshold → fewer buds/branches retained, resulting in a sparser, pruned structure.

  • execute_on_gpu (bool): [Read-Write] Whether this node should be executed on the GPU.

  • execution_dependency_required (bool): [Read-Write] If enabled, the execution dependency pin will require to be connected for execution (as any other required pin) and will be used for culling.

  • expose_to_library (bool): [Read-Write]

  • instance_spacing (float): [Read-Write] Minimum distance between placed instances.

    Higher spacing yields a more open distribution; lower spacing allows denser placement.

  • instance_spacing_ramp (PVFloatRamp): [Read-Write] Ramp that varies instance spacing across the height of the plant

    Useful to reduce spacing in some areas based on the height of the plant.

  • instance_spacing_ramp_effect (float): [Read-Write] Strength of the spacing ramp’s influence.

    Blends the ramp with the base spacing. Lower values favor the base spacing (subtle effect); higher values apply the ramp more strongly and can amplify spacing differences.

  • max_per_branch (int32): [Read-Write] Caps the number of instances per branch

    limit on how many foliage instances can be placed per branch to avoid overcrowding.

  • max_scale (float): [Read-Write] Maximum allowed instance size.

    Clamps the final computed scale so it never exceeds this value. Use to cap unusually large instances for visual consistency.

  • maximum_node_buds (int32): [Read-Write] Maximum buds/leaves per node.

    Caps the number of buds/leaves spawned. Use with MinimumNodeBuds to bound density and keep arrangements predictable. Applied when Whorled phyllotaxy is selected.

  • min_scale (float): [Read-Write] Minimum allowed instance size.

    Clamps the final computed scale so it never goes below this value. Use to prevent tiny, hard-to-see instances.

  • minimum_node_buds (int32): [Read-Write] Minimum buds/leaves per node.

    Sets the lower bound on the number of buds/leaves generated at each node. Guarantees at least this many instances (subject to spacing and other constraints). Should be ≤ MaximumNodeBuds. Applied when Whorled phyllotaxy is selected.

  • override_axil_angle (bool): [Read-Write] Use a custom axil angle instead of the default.

    Enables a user-defined orientation. When on, the system uses AxilAngle and the AxilAngleRamp settings (and Effect) to set the tilt of foliage relative to its parent branch direction, overriding any automatic/species defaults.

  • override_distribution (bool): [Read-Write] Override default placement with custom distribution rules.

    Overides the distribution settings loaded from the procedural vegetation preset.

  • override_phyllotaxy (bool): [Read-Write] Use custom phyllotaxy settings instead of defaults.

    Overide the phyllotaxy settings loaded from the procedural vegetation preset.

  • phyllotaxy_additional_angle (float): [Read-Write] Extra divergence angle (°) added to the phyllotaxy pattern

    Adds an angular offset to the base phyllotactic divergence.

  • phyllotaxy_formation (PhyllotaxyFormation): [Read-Write]

  • phyllotaxy_type (PhyllotaxyType): [Read-Write] Pattern for arranging buds/leaves around the stem.

    Selects the phyllotactic pattern used for placement (e.g., Alternate, Opposite, Whorled, Spiral). This defines the sequence and angular spacing of buds/leaves around the stem and along its length.

  • print_shader_debug_values (bool): [Read-Write] Enable use of ‘WriteDebugValue(uint Index, float Value)’ function in your kernel. Allows you to write float values to a buffer for logging on the CPU.

  • profile_kernel_index (int32): [Read-Write] Index of kernel emitted by this node to repeatedly dispatch every frame to enable profiling. Set to -1 to disable profiling. PCG_GPU_KERNEL_PROFILING must be defined in PCG.Build.cs.

  • random_scale_max (float): [Read-Write] Upper bound for per-instance size variation.

    Sets the maximum of the random scale range used to vary instance sizes. Each instance samples within Random Scale Min–Max, then combines with Base Scale and any ramps (respecting Min/Max Scale).

  • random_scale_min (float): [Read-Write] Lower bound for per-instance size variation.

    Sets the minimum of the random scale range used to vary instance sizes. Each instance samples within Random Scale Min–Max, then combines with Base Scale and any ramps (respecting Min/Max Scale).

  • random_seed (int32): [Read-Write]

  • scale_ramp (PVFloatRamp): [Read-Write] Curve that varies scale across the height of the plant

    Use to taper foliage toward tips or emphasize size in targeted regions.

  • seed (int32): [Read-Write]

  • trigger_render_capture (bool): [Read-Write] Will trigger a render capture when this node executes and a debug object is selected in the graph editor. Transient and Editor-only. Render captures must be enabled (e.g. -AttachRenderDoc or -AttachPIX).

  • use_seed (bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.