`unreal.PCGCopyPointsSettings`¶

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

Bases: PCGSettings

PCGCopy Points Settings

C++ Source:

Plugin: PCG
Module: PCG
File: PCGCopyPoints.h

Editor Properties: (see get_editor_property/set_editor_property)

apply_target_rotation_to_positions (bool): [Read-Write] If this option is set, points will have their source position transformed using the target transform with rotation
apply_target_scale_to_positions (bool): [Read-Write] If this option is set, points will have their source position transformed using the target transform with scale
attribute_inheritance (PCGCopyPointsMetadataInheritanceMode): [Read-Write] The method used to determine output data attributes
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]
color_inheritance (PCGCopyPointsInheritanceMode): [Read-Write] The method used to determine output point color
copy_each_source_on_every_target (bool): [Read-Write] If this option is set, each source point data will be copied to every target point data (cartesian product), producing N * M point data. Otherwise, will do a N:N (or N:1 or 1:N) operation, producing N point data.
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]
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]
match_attribute (Name): [Read-Write] Attribute that must be present on both the source data and the target point, and have the same value. EXPERIMENTAL: This feature is work in progress and is currently GPU-only. It may not be stable, and may be removed in the future.
match_based_on_attribute (bool): [Read-Write] Perform a conditional copy point where data pairs must have a matching attribute in order to participate in the copy operation. EXPERIMENTAL: This feature is work in progress and is currently GPU-only. It may not be stable, and may be removed in the future.
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.
rotation_inheritance (PCGCopyPointsInheritanceMode): [Read-Write] The method used to determine output point rotation
scale_inheritance (PCGCopyPointsInheritanceMode): [Read-Write] The method used to determine output point scale
seed (int32): [Read-Write]
seed_inheritance (PCGCopyPointsInheritanceMode): [Read-Write] The method used to determine output seed values. Relative recomputes the seed from the new location.
tag_inheritance (PCGCopyPointsTagInheritanceMode): [Read-Write] The method used to determine the output data tags
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.

property apply_target_rotation_to_positions: bool¶

[Read-Write] If this option is set, points will have their source position transformed using the target transform with rotation

Type:: (bool)

property apply_target_scale_to_positions: bool¶

[Read-Write] If this option is set, points will have their source position transformed using the target transform with scale

Type:: (bool)

property attribute_inheritance: PCGCopyPointsMetadataInheritanceMode¶

[Read-Write] The method used to determine output data attributes

Type:: (PCGCopyPointsMetadataInheritanceMode)

property color_inheritance: PCGCopyPointsInheritanceMode¶

[Read-Write] The method used to determine output point color

Type:: (PCGCopyPointsInheritanceMode)

property copy_each_source_on_every_target: bool¶

N (or N:1 or 1:N) operation, producing N point data.

Type:: (bool)
Type:: [Read-Write] If this option is set, each source point data will be copied to every target point data (cartesian product), producing N * M point data. Otherwise, will do a N

property match_attribute: Name¶

[Read-Write] Attribute that must be present on both the source data and the target point, and have the same value. EXPERIMENTAL: This feature is work in progress and is currently GPU-only. It may not be stable, and may be removed in the future.

Type:: (Name)

property match_based_on_attribute: bool¶

[Read-Write] Perform a conditional copy point where data pairs must have a matching attribute in order to participate in the copy operation. EXPERIMENTAL: This feature is work in progress and is currently GPU-only. It may not be stable, and may be removed in the future.