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, 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]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
(Name): [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 selectedmax_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.seed
(int32): [Read-Write]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-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_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.weight_attribute
(Name): [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.
- property input_weight_attribute: PCGAttributePropertyInputSelector¶
[Read-Write] Input weight from the points, assumed to be in the [0, 1] range.
- 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: Name¶
[Read-Write] Attribute from the attribute set to match against.
- Type:
(Name)
- 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:
- property max_distance_input_attribute: PCGAttributePropertyInputSelector¶
[Read-Write]
- 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:
- 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)