unreal.PCGAttributeRemapSettings

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

Bases: PCGMetadataSettingsBase

Remap attribute values from one range to another.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGAttributeRemap.h

Editor Properties: (see get_editor_property/set_editor_property)

  • allow_inverse_range (bool): [Read-Write] Allow remapping when Min is larger than Max, e.g. from [0.0, 1.0] -> [1.0, 0.0].

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

  • clamp_to_unit_range (bool): [Read-Write] If checked, outside values will be clamped between 0 and 1.

  • curve (RuntimeFloatCurve): [Read-Write] Note that this is no longer the default value for new nodes, it is now ‘true’

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

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

  • ignore_values_outside_input_range (bool): [Read-Write] Attribute values outside of the input range will be unaffected by the remapping

  • input_source (PCGAttributePropertyInputSelector): [Read-Write]

  • mode (PCGAttributeRemapMode): [Read-Write]

  • out_range_max (double): [Read-Write]

  • out_range_min (double): [Read-Write]

  • output_data_from_pin (Name): [Read-Write] By default, output is taken from first non-param pin (aka if the second pin is a point data, the output will be this point data). You can change it to any available input pin.

  • output_target (PCGAttributePropertyOutputSelector): [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.

  • range_max (double): [Read-Write] If InRangeMin = InRangeMax, then that attribute value is mapped to the average of OutRangeMin and OutRangeMax

  • range_min (double): [Read-Write] If InRangeMin = InRangeMax, then that attribute value is mapped to the average of OutRangeMin and OutRangeMax

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

[Read-Write] Allow remapping when Min is larger than Max, e.g. from [0.0, 1.0] -> [1.0, 0.0].

Type:

(bool)

property clamp_to_unit_range: bool

[Read-Write] If checked, outside values will be clamped between 0 and 1.

Type:

(bool)

property curve: RuntimeFloatCurve

[Read-Write] Note that this is no longer the default value for new nodes, it is now ‘true’

Type:

(RuntimeFloatCurve)

property ignore_values_outside_input_range: bool

[Read-Write] Attribute values outside of the input range will be unaffected by the remapping

Type:

(bool)

property input_source: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property mode: PCGAttributeRemapMode

[Read-Write]

Type:

(PCGAttributeRemapMode)

property out_range_max: float

[Read-Write]

Type:

(double)

property out_range_min: float

[Read-Write]

Type:

(double)

property range_max: float

[Read-Write] If InRangeMin = InRangeMax, then that attribute value is mapped to the average of OutRangeMin and OutRangeMax

Type:

(double)

property range_min: float

[Read-Write] If InRangeMin = InRangeMax, then that attribute value is mapped to the average of OutRangeMin and OutRangeMax

Type:

(double)