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, a breakpoint will be triggered in the execution code to enable debugging. Only applies when inspecting a debug object. Transient and Editor-only.

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

  • execution_dependency_required (bool): [Read-Write] If enabled, the execution dependency pin will require to be connected for execution (as any other required pin) and will be used for culling.

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

  • profile_kernel_index (int32): [Read-Write] Index of kernel emitted by this node to repeatedly dispatch every frame to enable profiling. Set to -1 to disable profiling. PCG_GPU_KERNEL_PROFILING must be defined in PCG.Build.cs.

  • 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

  • trigger_render_capture (bool): [Read-Write] Will trigger a render capture when this node executes and a debug object is selected in the graph editor. Transient and Editor-only. Render captures must be enabled (e.g. -AttachRenderDoc or -AttachPIX).

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