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] deprecated: Use OutputAttribute selector instead.

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

  • maximum_distance (double): [Read-Write] A maximum distance to search, which is used as an optimization

  • output_attribute (PCGAttributePropertySelector): [Read-Write] The attribute output for the resulting distance value.

  • output_distance_vector (bool): [Read-Write] Controls whether the attribute will be a scalar or a vector

  • output_to_attribute (bool): [Read-Write] Output the distance or distance vector to an attribute.

  • seed (int32): [Read-Write]

  • set_density (bool): [Read-Write] If true, will also set the density to be 0 - 1 based on MaximumDistance

  • source_shape (PCGDistanceShape): [Read-Write] What shape is used on the ‘source’ points

  • target_shape (PCGDistanceShape): [Read-Write] What shape is used on the ‘target’ points

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

property attribute_name: Name

[Read-Write] deprecated: Use OutputAttribute selector instead.

Type:

(Name)

property maximum_distance: float

[Read-Write] A maximum distance to search, which is used as an optimization

Type:

(double)

property output_attribute: PCGAttributePropertySelector

[Read-Write] The attribute output for the resulting distance value.

Type:

(PCGAttributePropertySelector)

property output_distance_vector: bool

[Read-Write] Controls whether the attribute will be a scalar or a vector

Type:

(bool)

property output_to_attribute: bool

[Read-Write] Output the distance or distance vector to an attribute.

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:

(PCGDistanceShape)

property target_shape: PCGDistanceShape

[Read-Write] What shape is used on the ‘target’ points

Type:

(PCGDistanceShape)