unreal.PVParametricSpacingSettings

class unreal.PVParametricSpacingSettings

Bases: StructBase

PVParametric Spacing Settings

C++ Source:

  • Plugin: ProceduralVegetationEditor

  • Module: ProceduralVegetation

  • File: PVDistributionParams.h

Editor Properties: (see get_editor_property/set_editor_property)

  • branch_density (int32): [Read-Write] Number of foliage instances per asset.

    Total instances scattered throughout the entire tree. Higher = denser foliage. Combine with RelativeStart and RelativeEnd to limit the range, and with SpacingRamp to vary density along the branch or plant.

  • end_generation (int32): [Read-Write] Last generation to receive foliage.

    Higher numbers include more generations. 10 = effectively unlimited.

  • limit_end_generation (bool): [Read-Write] Restrict placement to branches below an ending generation.

    When on, foliage stops at EndGeneration. Use to keep the finest twigs free of foliage.

  • limit_start_generation (bool): [Read-Write] Restrict placement to branches above a starting generation.

    When on, only branches at or beyond StartGeneration receive foliage. Use to keep the trunk bare while putting foliage on side branches.

  • relative_end (float): [Read-Write] Fraction along the branch where placement ends.

    1 = continues to the branch tip. Lower values stop placement before the tip — useful when you want clean tips without foliage.

  • relative_start (float): [Read-Write] Fraction along the branch where placement begins.

    0 = start from the branch base. 0.5 = start at the midpoint. Useful for plants that have bare lower stems or for separating the distribution into multiple distributors in a chain.

  • spacing_basis (PVDistributionBasis): [Read-Write] Whether the spacing ramp is normalized to the plant or to each branch.

    Plant: ramp covers the whole plant from 0 at the root and 1 at each tip. Branch: ramp covers each branch’s length individually.

  • spacing_ramp (PVFloatRamp): [Read-Write] Curve that varies instance spacing along the plant or branch.

    X = position along the spacing basis. Y = relative output position. Typical use case is leaving start and end as default and add a keypoint in between to concentrate the density of foliage either around the start and end.

  • start_generation (int32): [Read-Write] First generation to receive foliage.

    1 = trunk. 2 = first side branches. Higher numbers exclude lower-order branches from foliage placement.