unreal.PCGSplineIntersectionSettings

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

Bases: PCGSettings

Intersects splines against other splines (or themselves) and returns varied results based on user need.

C++ Source:

  • Plugin: PCG

  • Module: PCG

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

  • distance_threshold (double): [Read-Write] Maximum distance at which we report an intersection on the splines.

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

  • intersecting_spline_index_attribute (PCGAttributePropertyOutputSelector): [Read-Write] Attribute that will contain the first intersecting spline index, or -1 if not an intersection control point.

  • originating_spline_index_attribute (PCGAttributePropertyOutputSelector): [Read-Write] Attribute that will contain the first spline index (only in the output case of intersection points.)

  • output (PCGSplineIntersectionOutput): [Read-Write] Controls type of output result.

  • output_spline_indices (bool): [Read-Write] Controls whether the output will contain the index of the intersecting splines

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

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

  • type (PCGSplineIntersectionType): [Read-Write] Controls type of intersection test that will be done.

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

property distance_threshold: float

[Read-Write] Maximum distance at which we report an intersection on the splines.

Type:

(double)

property intersecting_spline_index_attribute: PCGAttributePropertyOutputSelector

[Read-Write] Attribute that will contain the first intersecting spline index, or -1 if not an intersection control point.

Type:

(PCGAttributePropertyOutputSelector)

property originating_spline_index_attribute: PCGAttributePropertyOutputSelector

[Read-Write] Attribute that will contain the first spline index (only in the output case of intersection points.)

Type:

(PCGAttributePropertyOutputSelector)

property output: PCGSplineIntersectionOutput

[Read-Write] Controls type of output result.

Type:

(PCGSplineIntersectionOutput)

property output_spline_indices: bool

[Read-Write] Controls whether the output will contain the index of the intersecting splines

Type:

(bool)

property type: PCGSplineIntersectionType

[Read-Write] Controls type of intersection test that will be done.

Type:

(PCGSplineIntersectionType)