unreal.PCGPrimitiveCrossSectionSettings

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

Bases: PCGSettings

Creates spline cross-sections of one more primitives based on vertex features.

C++ Source:

  • Plugin: PCGGeometryScriptInterop

  • Module: PCGGeometryScriptInterop

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

  • enable_min_area_culling (bool): [Read-Write] Cull tiers that have a surface area smaller than a specified threshold.

  • enable_min_height_culling (bool): [Read-Write] Culls tiers that don’t meed a minimum height requirement.

  • enable_tier_merging (bool): [Read-Write] Cull tiers that are within a specified threshold.

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

  • extrusion_vector_attribute (PCGAttributePropertyOutputSelector): [Read-Write] The attribute that will be populated with each cross-section’s extrusion vector.

  • max_mesh_vertex_count (int32): [Read-Write] A safeguard to prevent finding features on an overly complex mesh.

  • min_area_culling_threshold (double): [Read-Write] If a tier is smaller in area than this threshold, it will be culled.

  • min_height_culling_threshold (double): [Read-Write] If a tier is smaller in height than this threshold, it will be culled.

  • minimum_coplanar_vertices (int32): [Read-Write] The minimum required number of vertices that must be co-planar in order to be considered a tier “feature”.

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

  • remove_redundant_sections (bool): [Read-Write] If multiple tiers can be combined into a single tier without affecting the contour, remove the redundant one. Note: This will currently cull even if there are other unique tiers in between.

  • seed (int32): [Read-Write]

  • slice_direction (Vector): [Read-Write] Slicing will happen from the minimum vertex along this direction vector (normalized).

  • tier_merging_threshold (double): [Read-Write] If a tier is within this distance (in cm) of the previous tier, it will be culled.

  • 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 enable_min_area_culling: bool

[Read-Write] Cull tiers that have a surface area smaller than a specified threshold.

Type:

(bool)

property enable_min_height_culling: bool

[Read-Write] Culls tiers that don’t meed a minimum height requirement.

Type:

(bool)

property enable_tier_merging: bool

[Read-Write] Cull tiers that are within a specified threshold.

Type:

(bool)

property extrusion_vector_attribute: PCGAttributePropertyOutputSelector

[Read-Write] The attribute that will be populated with each cross-section’s extrusion vector.

Type:

(PCGAttributePropertyOutputSelector)

property max_mesh_vertex_count: int

[Read-Write] A safeguard to prevent finding features on an overly complex mesh.

Type:

(int32)

property min_area_culling_threshold: float

[Read-Write] If a tier is smaller in area than this threshold, it will be culled.

Type:

(double)

property min_height_culling_threshold: float

[Read-Write] If a tier is smaller in height than this threshold, it will be culled.

Type:

(double)

property minimum_coplanar_vertices: int

[Read-Write] The minimum required number of vertices that must be co-planar in order to be considered a tier “feature”.

Type:

(int32)

property remove_redundant_sections: bool

This will currently cull even if there are other unique tiers in between.

Type:

(bool)

Type:

[Read-Write] If multiple tiers can be combined into a single tier without affecting the contour, remove the redundant one. Note

property slice_direction: Vector

[Read-Write] Slicing will happen from the minimum vertex along this direction vector (normalized).

Type:

(Vector)

property tier_merging_threshold: float

[Read-Write] If a tier is within this distance (in cm) of the previous tier, it will be culled.

Type:

(double)