unreal.PCGMatchAndSetAttributesSettings

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

Bases: PCGSettings

This class creates a PCG node that can match, select by weight or match & select by weight a ‘matching’ entry in a provided Attribute Set with multiple entries. E.g. for a given point, if the point has the same specified attribute as the matching attribute in the attribute set, then we will copy all the other non-selection attributes to the point.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGMatchAndSetAttributes.h

Editor Properties: (see get_editor_property/set_editor_property)

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

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

  • find_nearest (bool): [Read-Write] Controls whether the match operation will return the nearest match and not only match on equality.

  • input_attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute from the point data to select & match.

  • input_weight_attribute (PCGAttributePropertyInputSelector): [Read-Write] Input weight from the points, assumed to be in the [0, 1] range.

  • keep_unmatched (bool): [Read-Write] Controls whether points that have no valid match in the attribute set are kept as is (default values) or removed from the output.

  • match_attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute from the attribute set to match against.

  • match_attributes (bool): [Read-Write] Controls whether selection of the attribute set values to copy will be done by matching point-to-attribute set (true) or done randomly (false).

  • max_distance_for_nearest_match (PCGMetadataTypesConstantStruct): [Read-Write] Constant value that establishes the maximum distance an entry can be from its nearest match to be selected

  • max_distance_input_attribute (PCGAttributePropertyInputSelector): [Read-Write]

  • max_distance_mode (PCGMatchMaxDistanceMode): [Read-Write] Controls whether the match operation has a maximum distance on which to reject points that would be too far from the nearest value.

  • 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_input_weight_attribute (bool): [Read-Write] Controls whether we will use the attribute provided in the Input Weight Attribute to perform entry selection.

  • use_seed (bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.

  • use_weight_attribute (bool): [Read-Write] Controls whether we will consider the weights, as determined by the Weight Attribute values on the attribute set.

  • warn_if_no_match_data (bool): [Read-Write] Controls whether we will emit a warning and return nothing if there is no provided attribute set.

  • warn_on_attribute_cast (bool): [Read-Write]

  • weight_attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute to weight more or less some entries from the attribute set.

property find_nearest: bool

[Read-Write] Controls whether the match operation will return the nearest match and not only match on equality.

Type:

(bool)

property input_attribute: PCGAttributePropertyInputSelector

[Read-Write] Attribute from the point data to select & match.

Type:

(PCGAttributePropertyInputSelector)

property input_weight_attribute: PCGAttributePropertyInputSelector

[Read-Write] Input weight from the points, assumed to be in the [0, 1] range.

Type:

(PCGAttributePropertyInputSelector)

property keep_unmatched: bool

[Read-Write] Controls whether points that have no valid match in the attribute set are kept as is (default values) or removed from the output.

Type:

(bool)

property match_attribute: PCGAttributePropertyInputSelector

[Read-Write] Attribute from the attribute set to match against.

Type:

(PCGAttributePropertyInputSelector)

property match_attributes: bool

[Read-Write] Controls whether selection of the attribute set values to copy will be done by matching point-to-attribute set (true) or done randomly (false).

Type:

(bool)

property max_distance_for_nearest_match: PCGMetadataTypesConstantStruct

[Read-Write] Constant value that establishes the maximum distance an entry can be from its nearest match to be selected

Type:

(PCGMetadataTypesConstantStruct)

property max_distance_input_attribute: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property max_distance_mode: PCGMatchMaxDistanceMode

[Read-Write] Controls whether the match operation has a maximum distance on which to reject points that would be too far from the nearest value.

Type:

(PCGMatchMaxDistanceMode)

property use_input_weight_attribute: bool

[Read-Write] Controls whether we will use the attribute provided in the Input Weight Attribute to perform entry selection.

Type:

(bool)

property use_weight_attribute: bool

[Read-Write] Controls whether we will consider the weights, as determined by the Weight Attribute values on the attribute set.

Type:

(bool)

property warn_if_no_match_data: bool

[Read-Write] Controls whether we will emit a warning and return nothing if there is no provided attribute set.

Type:

(bool)

property warn_on_attribute_cast: bool

[Read-Write]

Type:

(bool)

property weight_attribute: PCGAttributePropertyInputSelector

[Read-Write] Attribute to weight more or less some entries from the attribute set.

Type:

(PCGAttributePropertyInputSelector)