unreal.PCGSubdivisionBaseSettings

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

Bases: PCGSettings

PCGSubdivision Base Settings

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGSubdivisionBase.h

Editor Properties: (see get_editor_property/set_editor_property)

  • 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_color_attribute_name (Name): [Read-Write] Name of the Debug Color output attribute name, ignored if Forward Attributes From Modules Info is true.

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

  • forward_attributes_from_modules_info (bool): [Read-Write] Do a match and set with the incoming modules info, only if the modules info is passed as input.

  • grammar_selection (PCGGrammarSelection): [Read-Write] An encoded string that represents how to apply a set of rules to a series of defined modules.

  • module_info_as_input (bool): [Read-Write] Set it to true to pass the info as attribute set.

  • modules_info (Array[PCGSubdivisionSubmodule]): [Read-Write] Fixed array of modules used for the subdivision.

  • modules_info_attribute_names (PCGSubdivisionModuleAttributeNames): [Read-Write] Fixed array of modules used for the subdivision.

  • output_debug_color_attribute (bool): [Read-Write]

  • output_scalable_attribute (bool): [Read-Write]

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

  • scalable_attribute_name (Name): [Read-Write] Name of the Scalable output attribute name, ignored if Forward Attributes From Modules Info is true.

  • seed (int32): [Read-Write]

  • seed_attribute (PCGAttributePropertyInputSelector): [Read-Write] Attribute to use to drive seed selection. It should be convertible to an integer.

  • size_attribute_name (Name): [Read-Write] Name of the Size output attribute name, ignored if Forward Attributes From Modules Info is true.

  • symbol_attribute_name (Name): [Read-Write] Name of the Symbol output attribute name.

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

  • use_seed_attribute (bool): [Read-Write] Controls whether we’ll use an attribute to drive random seeding for stochastic processes in the subdivision.

property debug_color_attribute_name: Name

[Read-Write] Name of the Debug Color output attribute name, ignored if Forward Attributes From Modules Info is true.

Type:

(Name)

property forward_attributes_from_modules_info: bool

[Read-Write] Do a match and set with the incoming modules info, only if the modules info is passed as input.

Type:

(bool)

property grammar_selection: PCGGrammarSelection

[Read-Write] An encoded string that represents how to apply a set of rules to a series of defined modules.

Type:

(PCGGrammarSelection)

property module_info_as_input: bool

[Read-Write] Set it to true to pass the info as attribute set.

Type:

(bool)

property modules_info: None

[Read-Write] Fixed array of modules used for the subdivision.

Type:

(Array[PCGSubdivisionSubmodule])

property modules_info_attribute_names: PCGSubdivisionModuleAttributeNames

[Read-Write] Fixed array of modules used for the subdivision.

Type:

(PCGSubdivisionModuleAttributeNames)

property output_debug_color_attribute: bool

[Read-Write]

Type:

(bool)

property output_scalable_attribute: bool

[Read-Write]

Type:

(bool)

property output_size_attribute: bool

[Read-Write]

Type:

(bool)

property scalable_attribute_name: Name

[Read-Write] Name of the Scalable output attribute name, ignored if Forward Attributes From Modules Info is true.

Type:

(Name)

property seed_attribute: PCGAttributePropertyInputSelector

[Read-Write] Attribute to use to drive seed selection. It should be convertible to an integer.

Type:

(PCGAttributePropertyInputSelector)

property size_attribute_name: Name

[Read-Write] Name of the Size output attribute name, ignored if Forward Attributes From Modules Info is true.

Type:

(Name)

property symbol_attribute_name: Name

[Read-Write] Name of the Symbol output attribute name.

Type:

(Name)

property use_seed_attribute: bool

[Read-Write] Controls whether we’ll use an attribute to drive random seeding for stochastic processes in the subdivision.

Type:

(bool)