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] The name of the attribute to store on the point.Use ‘None’ to disablecategory
(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]filter_on_tags
(Set[str]): [Read-Write] Warning - this is deprecated and will be removed soon since we have a Filter By Tag node for this specific purposemaximum_distance
(double): [Read-Write] A maximum distance to search, which is used as an optimizationoutput_distance_vector
(bool): [Read-Write] Controls whether the attribute will be a scalar or a vectorpass_through_filtered_out_inputs
(bool): [Read-Write] Warning - this is deprecated and will be removed soon since we have a Filter By Tag node for this specific purposeseed
(int32): [Read-Write]set_density
(bool): [Read-Write] If true, will also set the density to be 0 - 1 based on MaximumDistancesource_shape
(PCGDistanceShape): [Read-Write] What shape is used on the ‘source’ pointstags_applied_on_output
(Set[str]): [Read-Write] Applies the specified tags on the output data. Note - this might be replaced by a dedicated Tagging nodetarget_shape
(PCGDistanceShape): [Read-Write] What shape is used on the ‘target’ pointsuse_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.
- property attribute_name: Name¶
[Read-Write] The name of the attribute to store on the point.Use ‘None’ to disable
- Type:
(Name)
- property maximum_distance: float¶
[Read-Write] A maximum distance to search, which is used as an optimization
- Type:
(double)
- property output_distance_vector: bool¶
[Read-Write] Controls whether the attribute will be a scalar or a vector
- 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:
- property target_shape: PCGDistanceShape¶
[Read-Write] What shape is used on the ‘target’ points
- Type: