`unreal.PCGCollapsePointsSettings`¶

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

Bases: PCGSettings

Collapses (decimates) points on a closest-point basis, allowing weighted averages to be computed as required.

C++ Source:

Plugin: PCG
Module: PCG
File: PCGCollapsePoints.h

Editor Properties: (see get_editor_property/set_editor_property)

attributes_to_merge (Array[PCGAttributePropertyOutputNoSourceSelector]): [Read-Write] List of attributes to merge on the final points, based on the weights.
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]
comparison_mode (PCGCollapseComparisonMode): [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]
description (Text): [Read-Write]
determinism_settings (PCGDeterminismSettings): [Read-Write]
distance_threshold (double): [Read-Write] Distance at which we will stop collapsing points. E.g. Points will continue collapsing until every point is at least this distance from each other.
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]
merge_weight_attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute that will drive relative weight when merging points (only in the Weighted mode).
mode (PCGCollapseMode): [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]
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_merge_weight_attribute (bool): [Read-Write] Controls whether input points will use a weight driven by an attribute
use_seed (bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.
visit_order (PCGCollapseVisitOrder): [Read-Write] Determines order in which we will collapse points pair-wise.
visit_order_attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute to drive visit order.

property attributes_to_merge: None¶

[Read-Write] List of attributes to merge on the final points, based on the weights.

Type:: (Array[PCGAttributePropertyOutputNoSourceSelector])

property comparison_mode: PCGCollapseComparisonMode¶

[Read-Write]

Type:: (PCGCollapseComparisonMode)

property distance_threshold: float¶

[Read-Write] Distance at which we will stop collapsing points. E.g. Points will continue collapsing until every point is at least this distance from each other.