unreal.PCGDistanceSettings

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

Bases: PCGSettings

Calculates the distance between two points (inherently a n*n operation)

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGDistance.h

Editor Properties: (see get_editor_property/set_editor_property)

  • attribute_name (Name): [Read-Write] deprecated: Use OutputAttribute selector instead.

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

  • check_source_against_respective_target (bool): [Read-Write] If this option is on, each source will be tested against its respective target (for a N:N operation). Source and Target num must be the same (or 1).

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

  • maximum_distance (double): [Read-Write] A maximum distance to search, which is used as an optimization

  • output_attribute (PCGAttributePropertySelector): [Read-Write] The attribute output for the resulting distance value.

  • output_distance_vector (bool): [Read-Write] Controls whether the attribute will be a scalar or a vector

  • output_to_attribute (bool): [Read-Write] Output the distance or distance vector to an attribute.

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

  • set_density (bool): [Read-Write] If true, will also set the density to be 0 - 1 based on MaximumDistance

  • source_shape (PCGDistanceShape): [Read-Write] What shape is used on the ‘source’ points

  • target_shape (PCGDistanceShape): [Read-Write] What shape is used on the ‘target’ points

  • 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 attribute_name: Name

[Read-Write] deprecated: Use OutputAttribute selector instead.

Type:

(Name)

property check_source_against_respective_target: bool

N operation). Source and Target num must be the same (or 1).

Type:

(bool)

Type:

[Read-Write] If this option is on, each source will be tested against its respective target (for a N

property maximum_distance: float

[Read-Write] A maximum distance to search, which is used as an optimization

Type:

(double)

property output_attribute: PCGAttributePropertySelector

[Read-Write] The attribute output for the resulting distance value.

Type:

(PCGAttributePropertySelector)

property output_distance_vector: bool

[Read-Write] Controls whether the attribute will be a scalar or a vector

Type:

(bool)

property output_to_attribute: bool

[Read-Write] Output the distance or distance vector to an attribute.

Type:

(bool)

property set_density: bool

[Read-Write] If true, will also set the density to be 0 - 1 based on MaximumDistance

Type:

(bool)

property source_shape: PCGDistanceShape

[Read-Write] What shape is used on the ‘source’ points

Type:

(PCGDistanceShape)

property target_shape: PCGDistanceShape

[Read-Write] What shape is used on the ‘target’ points

Type:

(PCGDistanceShape)