unreal.PCGCreatePointsGridSettings

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

Bases: PCGSettings

Creates a 2D or 3D grid of points.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGCreatePointsGrid.h

Editor Properties: (see get_editor_property/set_editor_property)

  • break_debugger (bool): [Read-Write] If a debugger is attached, triggers a breakpoint inside IPCGElement::Execute(). Editor only. Transient.

  • category (Text): [Read-Write]

  • cell_size (Vector): [Read-Write]

  • coordinate_space (PCGCoordinateSpace): [Read-Write] Sets the generation referential of the points

  • cull_points_outside_volume (bool): [Read-Write] If true, points are removed if they are outside of the volume

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

  • grid_extents (Vector): [Read-Write]

  • point_position (PCGPointPosition): [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.

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

  • set_points_bounds (bool): [Read-Write] If true, the bounds of the points are set to 50.0, if false, 1.0

  • use_seed (bool): [Read-Write] deprecated: Implement the PCGSettings virtual UseSeed() override.

property cell_size: Vector

[Read-Write]

Type:

(Vector)

property coordinate_space: PCGCoordinateSpace

[Read-Write] Sets the generation referential of the points

Type:

(PCGCoordinateSpace)

property cull_points_outside_volume: bool

[Read-Write] If true, points are removed if they are outside of the volume

Type:

(bool)

property grid_extents: Vector

[Read-Write]

Type:

(Vector)

property point_position: PCGPointPosition

[Read-Write]

Type:

(PCGPointPosition)

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 set_points_bounds: bool

[Read-Write] If true, the bounds of the points are set to 50.0, if false, 1.0

Type:

(bool)