`unreal.PCGAttributeFilteringSettings`¶

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

Bases: PCGSettings

Filter elements by attribute that allows to do “A op B” type filtering, where A is the input spatial data or Attribute set, and B is either a constant, another spatial data (if input is a spatial data), an Attribute set (in filter) or the input itself. The filtering can be done either on properties or attributes. Some examples: - Threshold on property by constant (A.Density > 0.5) - Threshold on attribute by constant (A.aaa != “bob”) - Threshold on property by metadata attribute(A.density >= B.bbb) - Threshold on property by property(A.density <= B.steepness) - Threshold on attribute by metadata attribute(A.aaa < B.bbb) - Threshold on attribute by property(A.aaa == B.color)

C++ Source:

Plugin: PCG
Module: PCG
File: PCGAttributeFilter.h

Editor Properties: (see get_editor_property/set_editor_property)

attribute_types (PCGMetadataTypesConstantStruct): [Read-Write]
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]
generate_output_data_even_if_empty (bool): [Read-Write] Always generate output data (possibly empty) for both the in and out filters, even if all/none of the elements were filtered.
operator (PCGAttributeFilterOperator): [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]
target_attribute (PCGAttributePropertyInputSelector): [Read-Write] Target property/attribute related properties
threshold_attribute (PCGAttributePropertyInputSelector): [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_constant_threshold (bool): [Read-Write] Threshold property/attribute/constant related properties
use_seed (bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.
use_spatial_query (bool): [Read-Write] If the threshold data is Point data, it will sample input points in threshold data. Always true with Spatial data.
warn_on_data_missing_attribute (bool): [Read-Write] Controls whether the node will emit a warning when the input data or the filter data doesn’t have the attribute to filter on.