unreal.PCGPointNeighborhoodSettings

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

Bases: PCGSettings

Computes quantities from nearby neighbor points, such as average density, color, and position.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGPointNeighborhood.h

Editor Properties: (see get_editor_property/set_editor_property)

  • average_position_attribute (Name): [Read-Write] The output attribute name to write the average positions, if not “None”.

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

  • distance_attribute (Name): [Read-Write] The output attribute name to write the non-normalized distance, if not “None”.

  • enabled (bool): [Read-Write]

  • expose_to_library (bool): [Read-Write]

  • search_distance (double): [Read-Write]

  • seed (int32): [Read-Write]

  • set_average_color (bool): [Read-Write] Writes the target color to the point color if true, otherwise keeps the source color.

  • set_average_position (bool): [Read-Write] Writes the average position to the point transform.

  • set_average_position_to_attribute (bool): [Read-Write] Allows the average position to be output into a user-generated attribute.

  • set_density (PCGPointNeighborhoodDensityMode): [Read-Write] Writes either the normalized distance or the average density to the point density.

  • set_distance_to_attribute (bool): [Read-Write] Allows the non-normalized distance to be output into a user-generated attribute.

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

  • weighted_average (bool): [Read-Write] Takes the bounds into account when projecting points.

property average_position_attribute: Name

[Read-Write] The output attribute name to write the average positions, if not “None”.

Type:

(Name)

property distance_attribute: Name

[Read-Write] The output attribute name to write the non-normalized distance, if not “None”.

Type:

(Name)

property search_distance: float

[Read-Write]

Type:

(double)

property set_average_color: bool

[Read-Write] Writes the target color to the point color if true, otherwise keeps the source color.

Type:

(bool)

property set_average_position: bool

[Read-Write] Writes the average position to the point transform.

Type:

(bool)

property set_average_position_to_attribute: bool

[Read-Write] Allows the average position to be output into a user-generated attribute.

Type:

(bool)

property set_density: PCGPointNeighborhoodDensityMode

[Read-Write] Writes either the normalized distance or the average density to the point density.

Type:

(PCGPointNeighborhoodDensityMode)

property set_distance_to_attribute: bool

[Read-Write] Allows the non-normalized distance to be output into a user-generated attribute.

Type:

(bool)

property weighted_average: bool

[Read-Write] Takes the bounds into account when projecting points.

Type:

(bool)