`unreal.PCGAttractSettings`¶

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

Bases: PCGSettings

Attracts points (interpolates) from the source towards points from the target.

C++ Source:

Plugin: PCG
Module: PCG
File: PCGAttractElement.h

Editor Properties: (see get_editor_property/set_editor_property)

attractor_index_attribute (PCGAttributePropertyInputSelector): [Read-Write] Index attribute on the source that maps a point to a point from the target.
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]
description (Text): [Read-Write]
determinism_settings (PCGDeterminismSettings): [Read-Write]
distance (double): [Read-Write] Will be used to determine which points to attract.
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]
mode (PCGAttractMode): [Read-Write] Controls the criteria used for the attract operation.
output_attract_index (bool): [Read-Write]
output_attract_index_attribute (PCGAttributePropertyOutputNoSourceSelector): [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.
remove_unattracted_points (bool): [Read-Write] Can optionally remove points that weren’t attracted to points on the target. Will have no effect when the source is the target.
seed (int32): [Read-Write]
source_and_target_attribute_mapping (Map[PCGAttributePropertyInputSelector, PCGAttributePropertyInputSelector]): [Read-Write]
source_weight_attribute (PCGAttributePropertyInputSelector): [Read-Write] This attribute will determine the weight of the fusion result for the source point. It will be normalized to the range of [0..1].
target_attribute (PCGAttributePropertyInputSelector): [Read-Write] The target attribute used when attracted by attribute value.
target_weight_attribute (PCGAttributePropertyInputSelector): [Read-Write] This attribute will determine the weight of the fusion result for the target point. It will be normalized to the range of [0..1].
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.
use_source_weight (bool): [Read-Write]
use_target_weight (bool): [Read-Write]
weight (double): [Read-Write]