unreal.PCGCreatePolygon2DSettings

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

Bases: PCGSettings

Creates polygon(s) from the specified point data.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGCreatePolygon2D.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]

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

  • hole_index_attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute that describes the hole index of the points, where -1 is the outer polygon, and other values are for holes. Expects values on inputs to be sequential and increasing only. Note that this will be used only on point data.

  • input_type (PCGCreatePolygonInputType): [Read-Write] Controls the way input data will be considered - either as closed or open paths.

  • open_polygon_width (double): [Read-Write] Target width of the polygon generated from an open path.

  • polygon_width_attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute from which to get the width value

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

  • spline_max_discretization_error (double): [Read-Write] Maximum squared distance before we need to subdivide a segment again as part of the spline discretization to a polygon.

  • 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_hole_attribute (bool): [Read-Write] Controls whether we will use the hole attribute to separate outer from hole segments. Note that the attribute will be used only when the input is a point data.

  • use_polygon_width_attribute (bool): [Read-Write] Controls whether target polygon width (when open/forced open) will be driven by an attribute.

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

property hole_index_attribute: PCGAttributePropertyInputSelector

[Read-Write] Attribute that describes the hole index of the points, where -1 is the outer polygon, and other values are for holes. Expects values on inputs to be sequential and increasing only. Note that this will be used only on point data.

Type:

(PCGAttributePropertyInputSelector)

property input_type: PCGCreatePolygonInputType

[Read-Write] Controls the way input data will be considered - either as closed or open paths.

Type:

(PCGCreatePolygonInputType)

property open_polygon_width: float

[Read-Write] Target width of the polygon generated from an open path.

Type:

(double)

property polygon_width_attribute: PCGAttributePropertyInputSelector

[Read-Write] Attribute from which to get the width value

Type:

(PCGAttributePropertyInputSelector)

property spline_max_discretization_error: float

[Read-Write] Maximum squared distance before we need to subdivide a segment again as part of the spline discretization to a polygon.

Type:

(double)

property use_hole_attribute: bool

[Read-Write] Controls whether we will use the hole attribute to separate outer from hole segments. Note that the attribute will be used only when the input is a point data.

Type:

(bool)

property use_polygon_width_attribute: bool

[Read-Write] Controls whether target polygon width (when open/forced open) will be driven by an attribute.

Type:

(bool)