unreal.PCGApplyHierarchySettings

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

Bases: PCGSettings

Applies hierarchy transformations based on a hierarchy depth, point index & parent index scheme. This is used in the context of PCG Data Assets that have these fields by default.

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGApplyHierarchy.h

Editor Properties: (see get_editor_property/set_editor_property)

  • apply_hierarchy (PCGApplyHierarchyOption): [Read-Write]

  • apply_hierarchy_attribute (PCGAttributePropertyInputSelector): [Read-Write]

  • apply_parent_rotation (PCGApplyHierarchyOption): [Read-Write]

  • apply_parent_rotation_attribute (PCGAttributePropertyInputSelector): [Read-Write]

  • apply_parent_scale (PCGApplyHierarchyOption): [Read-Write]

  • apply_parent_scale_attribute (PCGAttributePropertyInputSelector): [Read-Write]

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

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

  • hierarchy_depth_attribute (PCGAttributePropertyInputSelector): [Read-Write]

  • parent_key_attributes (Array[PCGAttributePropertyInputSelector]): [Read-Write] Attributes that constitute a unique key representing the point’s parent in the hierarchy. All attributes must be int32 at this time.

  • point_key_attributes (Array[PCGAttributePropertyInputSelector]): [Read-Write] Attributes that constitute a unique key representing the point. All attributes must be int32 at this time.

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

  • relative_transform_attribute (PCGAttributePropertyInputSelector): [Read-Write]

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

  • warn_on_points_with_invalid_parent (bool): [Read-Write]

property apply_hierarchy: PCGApplyHierarchyOption

[Read-Write]

Type:

(PCGApplyHierarchyOption)

property apply_hierarchy_attribute: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property apply_parent_rotation: PCGApplyHierarchyOption

[Read-Write]

Type:

(PCGApplyHierarchyOption)

property apply_parent_rotation_attribute: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property apply_parent_scale: PCGApplyHierarchyOption

[Read-Write]

Type:

(PCGApplyHierarchyOption)

property apply_parent_scale_attribute: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property hierarchy_depth_attribute: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property parent_key_attributes: None

[Read-Write] Attributes that constitute a unique key representing the point’s parent in the hierarchy. All attributes must be int32 at this time.

Type:

(Array[PCGAttributePropertyInputSelector])

property point_key_attributes: None

[Read-Write] Attributes that constitute a unique key representing the point. All attributes must be int32 at this time.

Type:

(Array[PCGAttributePropertyInputSelector])

property relative_transform_attribute: PCGAttributePropertyInputSelector

[Read-Write]

Type:

(PCGAttributePropertyInputSelector)

property warn_on_points_with_invalid_parent: bool

[Read-Write]

Type:

(bool)