unreal.PVGrowerPhyllotaxyParams

class unreal.PVGrowerPhyllotaxyParams

Bases: StructBase

PVGrower Phyllotaxy Params

C++ Source:

  • Plugin: ProceduralVegetationEditor

  • Module: ProceduralVegetation

  • File: PVGrowerParams.h

Editor Properties: (see get_editor_property/set_editor_property)

  • additional_angle (float): [Read-Write] Extra rotation added to each node’s phyllotaxy angle.

    Adds to the base angle picked by Type/Formation. E.g., Octastichous base = 135°; with AdditionalAngle = 10°, effective per-node rotation = 145°. Used to break perfect regularity or to author Parastichous patterns (where base = 0°, so this drives the entire rotation).

  • axil_angle (float): [Read-Write] Angle in degrees between child branches and the parent direction.

    0° = child branch points along the parent axis (rare). 90° = child sticks straight out (perpendicular). Negative values up to -90° (typed manually) make the child point backward. Larger angles widen the canopy; smaller angles produce columnar shapes.

  • flatten (float): [Read-Write] Flatten the 3D phyllotaxy onto a 2D plane.

    At 0, the phyllotaxy spirals fully in 3D. At 1, branches flattens out relative to the branches up direction. Useful for plants that have a spiral phyllotaxy but appears to flatten out.

  • formation (PVGrowthPhyllotaxyFormation): [Read-Write] Sub-angle for spiral phyllotaxy.

    Represents the number of branches that occurs in a 360 degree rotation. Distichous (180°), Tristichous (120°), Pentastichous (144°), Octastichous (135°, the default — closest to Fibonacci), or Parastichous (0° — free-form, requires manual Additional Angle / Offset).

  • max (uint32): [Read-Write] Maximum number of buds per node for Whorled phyllotaxy.

    Upper bound on whorl branch count. See Min above.

  • min (uint32): [Read-Write] Minimum number of buds per node for Whorled phyllotaxy.

    Each whorl spawns between Min and Max branches, picked at random. Set Min == Max for predictable counts. Typical values: 3-5 for a open whorl, 6-8 for an tight one.

  • offset (float): [Read-Write] Initial rotation of the phyllotaxy pattern.

    Phase-shifts the whole spiral. Doesn’t change per-node spacing, just where the first bud starts. Useful for an overall offset without other changes to the phyllotaxy.

  • reset (bool): [Read-Write] Reset phyllotaxy at each branch boundary.

    When enabled, each new branch starts its phyllotaxy fresh relative to the branch up direction. When disabled, the rotation is successively inherited from its previous generation and resumes its rotation from that point.

  • stagger (float): [Read-Write] Jitter the apical bud opposite to activating axillary buds.

    Adds asymmetry to the growth direction when a side branch activates — the apical tip slightly bends away from the new side branch. Higher values create more wandering, irregular branch paths.

  • type (PVGrowthPhyllotaxyType): [Read-Write] Pattern for arranging buds around the stem.

    Alternate (180° flip per node), Opposite (paired buds), Decussate (paired buds rotating 90°), Whorled (2+ buds per node), or Spiral (continuous rotation using the Formation sub-type).