unreal.PCGElevationIsolinesSettings

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

Bases: PCGSettings

Compute the elevation isolines of a surface, can output either points or splines. Currently only work for Z-up surfaces.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGElevationIsolines.h

Editor Properties: (see get_editor_property/set_editor_property)

  • add_tag_on_output_for_same_elevation (bool): [Read-Write] Can add a tag (integer) to group output data that are at the same elevation.

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

  • elevation_end (double): [Read-Write] Maximum elevation of the isolines.

  • elevation_increment (double): [Read-Write] Increment elevation between each isolines.

  • elevation_start (double): [Read-Write] Minimum elevation of the isolines.

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

  • linear_spline (bool): [Read-Write] Spline can either be curved or linear.

  • output_as_spline (bool): [Read-Write] Will output splines rather than points.

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

  • project_surface_normal (bool): [Read-Write] Option to either have Z up or project the surface normal at this position (similar to project rotations on the projection node).

  • resolution (double): [Read-Write] Resolution of the grid for the discretization of the surface. This is the size of one cell, in cm.

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

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

property add_tag_on_output_for_same_elevation: bool

[Read-Write] Can add a tag (integer) to group output data that are at the same elevation.

Type:

(bool)

property elevation_end: float

[Read-Write] Maximum elevation of the isolines.

Type:

(double)

property elevation_increment: float

[Read-Write] Increment elevation between each isolines.

Type:

(double)

property elevation_start: float

[Read-Write] Minimum elevation of the isolines.

Type:

(double)

property linear_spline: bool

[Read-Write] Spline can either be curved or linear.

Type:

(bool)

property output_as_spline: bool

[Read-Write] Will output splines rather than points.

Type:

(bool)

property project_surface_normal: bool

[Read-Write] Option to either have Z up or project the surface normal at this position (similar to project rotations on the projection node).

Type:

(bool)

property resolution: float

[Read-Write] Resolution of the grid for the discretization of the surface. This is the size of one cell, in cm.

Type:

(double)