unreal.PVRemoveBranchesSettings

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

Bases: PVBaseSettings

PVRemove Branches Settings

C++ Source:

  • Plugin: ProceduralVegetationEditor

  • Module: ProceduralVegetation

  • File: PVRemoveBranchesSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • branch_remove_basis (RemoveBranchesBasis): [Read-Write] Sets the rule used to remove branches.

    Chooses the basis for pruning (e.g., generation, length from root, age, or radius). Determines which branches are candidates for removal.

  • 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]

  • 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]

  • 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.

  • seed (int32): [Read-Write]

  • threshold (float): [Read-Write] Removal threshold for the chosen basis.

    Branches exceeding or falling below this threshold (per the selected basis) are removed. Use lower/higher values to prune sparsely or aggressively.

  • 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.