unreal.PCGPointNeighborhoodSettings¶
- class unreal.PCGPointNeighborhoodSettings(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
PCGSettingsComputes quantities from nearby neighbor points, such as average density, color, and position.
C++ Source:
Plugin: PCG
Module: PCG
File: PCGPointNeighborhood.h
Editor Properties: (see get_editor_property/set_editor_property)
average_position_attribute(Name): [Read-Write] The output attribute name to write the average positions, if not “None”.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_attribute(Name): [Read-Write] The output attribute name to write the non-normalized distance, if not “None”.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]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.search_distance(double): [Read-Write]seed(int32): [Read-Write]set_average_color(bool): [Read-Write] Writes the target color to the point color if true, otherwise keeps the source color.set_average_position(bool): [Read-Write] Writes the average position to the point transform.set_average_position_to_attribute(bool): [Read-Write] Allows the average position to be output into a user-generated attribute.set_density(PCGPointNeighborhoodDensityMode): [Read-Write] Writes either the normalized distance or the average density to the point density.set_distance_to_attribute(bool): [Read-Write] Allows the non-normalized distance to be output into a user-generated attribute.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.weighted_average(bool): [Read-Write] Takes the bounds into account when projecting points.
- property average_position_attribute: Name¶
[Read-Write] The output attribute name to write the average positions, if not “None”.
- Type:
(Name)
- property distance_attribute: Name¶
[Read-Write] The output attribute name to write the non-normalized distance, if not “None”.
- Type:
(Name)
- property set_average_color: bool¶
[Read-Write] Writes the target color to the point color if true, otherwise keeps the source color.
- Type:
(bool)
- property set_average_position: bool¶
[Read-Write] Writes the average position to the point transform.
- Type:
(bool)
- property set_average_position_to_attribute: bool¶
[Read-Write] Allows the average position to be output into a user-generated attribute.
- Type:
(bool)
- property set_density: PCGPointNeighborhoodDensityMode¶
[Read-Write] Writes either the normalized distance or the average density to the point density.
- Type: