unreal.PCGSurfaceSamplerSettings¶
- class unreal.PCGSurfaceSamplerSettings(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
PCGSettingsPCGSurface 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_buffer_size(int32): [Read-Write] Size (in number of floats) of the shader debug print buffer.debug_settings(PCGDebugVisualizationSettings): [Read-Write]description(Text): [Read-Write]determinism_settings(PCGDeterminismSettings): [Read-Write]dump_cooked_hlsl(bool): [Read-Write] Dump the cooked HLSL into the log after it is generated.dump_data_descriptions(bool): [Read-Write] Dump the data descriptions of input/output pins to the log.enabled(bool): [Read-Write]execute_on_gpu(bool): [Read-Write] Whether this node should be executed on the GPU.expose_to_library(bool): [Read-Write]keep_zero_density_points(bool): [Read-Write]looseness(float): [Read-Write] Controls how points are placed in their cell with 0 being in the center and 1 being anywhere inside the full cell size.point_extents(Vector): [Read-Write] Extents of the points to create (e.g. half their total size)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] Controls the grid cell size, down to a minimum size defined by the Point Extents.print_shader_debug_values(bool): [Read-Write] Enable use of ‘WriteDebugValue(uint Index, float Value)’ function in your kernel. Allows you to write float values to a buffer for logging on the CPU.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_legacy_grid_creation_method(bool): [Read-Write] Controls whether the prior grid creation mechanism (with cells being extents * (1 + steepness), then filtered by points by squared meters) is used.use_seed(bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.
- property looseness: float¶
[Read-Write] Controls how points are placed in their cell with 0 being in the center and 1 being anywhere inside the full cell size.
- Type:
(float)
- property point_extents: Vector¶
[Read-Write] Extents of the points to create (e.g. half their total size)
- 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] Controls the grid cell size, down to a minimum size defined by the Point Extents.
- Type:
(float)