unreal.PCGSurfaceSamplerSettings

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

Bases: PCGSettings

PCGSurface Sampler Settings

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGSurfaceSampler.h

Editor Properties: (see get_editor_property/set_editor_property)

  • apply_density_to_points (bool): [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]

  • keep_zero_density_points (bool): [Read-Write]

  • looseness (float): [Read-Write]

  • point_extents (Vector): [Read-Write]

  • point_steepness (float): [Read-Write] Each PCG point represents a discretized, volumetric region of world space. The points’ Steepness value [0.0 to 1.0] establishes how “hard” or “soft” that volume will be represented. From 0, it will ramp up linearly increasing its influence over the density from the point’s center to up to two times the bounds. At 1, it will represent a binary box function with the size of the point’s bounds.

  • points_per_squared_meter (float): [Read-Write]

  • seed (int32): [Read-Write]

  • unbounded (bool): [Read-Write] If no Bounding Shape input is provided, the actor bounds are used to limit the sample generation domain. This option allows ignoring the actor bounds and generating over the entire surface. Use with caution as this may generate a lot of 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 apply_density_to_points: bool

[Read-Write]

Type:

(bool)

property keep_zero_density_points: bool

[Read-Write]

Type:

(bool)

property looseness: float

[Read-Write]

Type:

(float)

property point_extents: Vector

[Read-Write]

Type:

(Vector)

property point_steepness: float

[Read-Write] Each PCG point represents a discretized, volumetric region of world space. The points’ Steepness value [0.0 to 1.0] establishes how “hard” or “soft” that volume will be represented. From 0, it will ramp up linearly increasing its influence over the density from the point’s center to up to two times the bounds. At 1, it will represent a binary box function with the size of the point’s bounds.

Type:

(float)

property points_per_squared_meter: float

[Read-Write]

Type:

(float)

property unbounded: bool

[Read-Write] If no Bounding Shape input is provided, the actor bounds are used to limit the sample generation domain. This option allows ignoring the actor bounds and generating over the entire surface. Use with caution as this may generate a lot of points.

Type:

(bool)