unreal.PCGBlueprintPointProcessorSimpleElement

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

Bases: PCGBlueprintBaseElement

Simple point processor element that supports the following two overrides: - RangePointLoopBody is the more efficient but more complex loop operating on a point range per call. - PointLoopBody is the less efficient but simplest loop operating on a single point per call.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGBlueprintPointProcessorSimpleElement.h

Editor Properties: (see get_editor_property/set_editor_property)

  • category (Text): [Read-Write]

  • compute_full_data_crc (bool): [Read-Write] In cases where your node is non-cacheable but is likely to yield the same results on subsequent executions, this controls whether we will do a deep & computationally intensive CRC computation (true), which will allow cache usage in downstream nodes in your graph, or, by default (false), a shallow but quick crc computation which will not be cache-friendly.

  • custom_input_pins (Array[PCGPinProperties]): [Read-Write]

  • custom_output_pins (Array[PCGPinProperties]): [Read-Write]

  • dependency_parsing_depth (int32): [Read-Write]

  • description (Text): [Read-Write]

  • enable_preconfigured_settings (bool): [Read-Write]

  • expose_to_library (bool): [Read-Write]

  • has_default_in_pin (bool): [Read-Write]

  • has_default_out_pin (bool): [Read-Write]

  • has_dynamic_pins (bool): [Read-Write] If enabled, by default, the Out pin type will have the union of In pin types. Default only works if the pins are In and Out. For custom behavior, implement DynamicPinTypesOverride.

  • inherit_metadata (bool): [Read-Write] If true, output will inherit metadata from inputs

  • inherit_spatial_data (bool): [Read-Write] If true, output will inherit spatial data from inputs

  • is_cacheable (bool): [Read-Write] Controls whether results can be cached so we can bypass execution if the inputs & settings are the same in a subsequent execution. If you have implemented the IsCacheableOverride function, then this value is ignored. Note that if your node relies on data that is not directly tracked by PCG or creates any kind of artifact (adds components, creates actors, etc.) then it should not be cacheable.

  • only_expose_preconfigured_settings (bool): [Read-Write]

  • preconfigured_info (Array[PCGPreConfiguredSettingsInfo]): [Read-Write]

  • properties_to_allocate (int32): [Read-Write] Specify which properties to allocate on the outputs

  • requires_game_thread (bool): [Read-Write] Controls whether this node execution can be run from a non-game thread. This is not related to the Loop functions provided/implemented in this class, which should always run on any thread.

property inherit_metadata: bool

[Read-Write] If true, output will inherit metadata from inputs

Type:

(bool)

property inherit_spatial_data: bool

[Read-Write] If true, output will inherit spatial data from inputs

Type:

(bool)

initialize(input_point_data, output_point_data) → None

Allows initialization of the output point data before the loop body calls. Called once per pin input - output pair.

Parameters:
point_loop_body(point_data, point, out_point_data, point_index) → PCGPoint or None

Multi-threaded loop that will iterate on all points in InPointData. All points will be added in the same order than in input.

Parameters:

  • point_data (PCGBasePointData) – Input point data. Constant, must not be modified.

  • point (PCGPoint) – Point for the current iteration. Constant, must not be modified.

  • out_point_data (PCGBasePointData) – Output point data. Can be modified.

  • point_index (int64) – Index of the current point. Must only be used to access input data, as this call is multi-threaded. It is not safe to access output data.

Returns:

True if the point should be kept, False if not.

out_point (PCGPoint): Point that will be added to the output data. Can be modified.

Return type:

PCGPoint or None

property properties_to_allocate: int

[Read-Write] Specify which properties to allocate on the outputs

Type:

(int32)

range_point_loop_body(input_range, output_range) -> (int32, output_range=PCGPointOutputRange)

Multi-threaded loop that will iterate on all points. All points will be added in the same order than in input. Each call will work on a subset of the data (ranges).

Parameters:

  • input_range (PCGPointInputRange) – Input Range. Constant, must not be modified. Can be used to get property value ranges on the Input point data.

  • output_range (PCGPointOutputRange) – Output Range. Can be modified. Can be used to set property value ranges on the Output point data.

Returns:

Number of points that were written.

output_range (PCGPointOutputRange): Output Range. Can be modified. Can be used to set property value ranges on the Output point data.

Return type:

PCGPointOutputRange