unreal.PCGSplitSplinesSettings

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

Bases: PCGSettings

Splits spline at a specific distance(s), key(s) or at certain values.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGSplitSplines.h

Editor Properties: (see get_editor_property/set_editor_property)

  • attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute identifying either the provenance of the split constants (key, distance or alpha) or the predicate on the control points.

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

  • constant (double): [Read-Write] Constant (either Key, Distance or Alpha) that will be used to split the splines.

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

  • mode (PCGSplitSplineMode): [Read-Write] Split criteria.

  • output_originating_spline_index (PCGAttributePropertyOutputSelector): [Read-Write] Attribute to write the originating spline index to.

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

  • should_output_originating_spline_index (bool): [Read-Write] Controls whether the output spline will have an attribute containing the index of the originating spline.

  • 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_constant (bool): [Read-Write] Controls whether the input splines will be cut using a single constant or values driven either by an additional input or based on a predicate on the spline control points.

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

property attribute: PCGAttributePropertyInputSelector

[Read-Write] Attribute identifying either the provenance of the split constants (key, distance or alpha) or the predicate on the control points.

Type:

(PCGAttributePropertyInputSelector)

property constant: float

[Read-Write] Constant (either Key, Distance or Alpha) that will be used to split the splines.

Type:

(double)

property mode: PCGSplitSplineMode

[Read-Write] Split criteria.

Type:

(PCGSplitSplineMode)

property output_originating_spline_index: PCGAttributePropertyOutputSelector

[Read-Write] Attribute to write the originating spline index to.

Type:

(PCGAttributePropertyOutputSelector)

property should_output_originating_spline_index: bool

[Read-Write] Controls whether the output spline will have an attribute containing the index of the originating spline.

Type:

(bool)

property use_constant: bool

[Read-Write] Controls whether the input splines will be cut using a single constant or values driven either by an additional input or based on a predicate on the spline control points.

Type:

(bool)