unreal.PCGAttributeFilteringSettings

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

Bases: PCGSettings

Attribute filter 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, triggers a breakpoint inside IPCGElement::Execute(). Editor only. Transient.

  • category (Text): [Read-Write]

  • debug (bool): [Read-Write]

  • debug_settings (PCGDebugVisualizationSettings): [Read-Write]

  • description (Text): [Read-Write]

  • determinism_settings (PCGDeterminismSettings): [Read-Write]

  • enabled (bool): [Read-Write]

  • expose_to_library (bool): [Read-Write]

  • operator (PCGAttributeFilterOperator): [Read-Write]

  • seed (int32): [Read-Write]

  • target_attribute (PCGAttributePropertyInputSelector): [Read-Write] Target property/attribute related properties

  • threshold_attribute (PCGAttributePropertyInputSelector): [Read-Write]

  • use_constant_threshold (bool): [Read-Write] Threshold property/attribute/constant related properties

  • use_seed (bool): [Read-Only] By default, settings won’t use a seed. Set this bool to true in the child ctor to allow edition and use it.

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

property attribute_types: PCGMetadataTypesConstantStruct

[Read-Write]

Type:

(PCGMetadataTypesConstantStruct)

property operator: PCGAttributeFilterOperator

[Read-Write]

Type:

(PCGAttributeFilterOperator)

property target_attribute: PCGAttributePropertyInputSelector

[Read-Write] Target property/attribute related properties

Type:

(PCGAttributePropertyInputSelector)

property threshold_attribute: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property use_constant_threshold: bool

[Read-Write] Threshold property/attribute/constant related properties

Type:

(bool)

property 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.

Type:

(bool)