unreal.HairCardGeneratorPluginSettings

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

Bases: HairCardGenerationSettings

Self contained hair card generation settings. Separated/Duplicated from the groom asset to: (1) constrain the prompt window’s details view, and (2) let the user modify it without mutating the original groom (settings should only be applied/saved when the process is done).

UHairCardGenerationPluginSettings holds all the generation settings required to regenerate hair cards for a particular groom asset. Implements the UHairCardGenerationSettings interface so that it can be used with the hair card generation extension module (see IHairCardGenerator API).

C++ Source:

• Plugin: HairCardGenerator

• Module: HairCardGeneratorEditor

• File: HairCardGeneratorPluginSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

• atlas_size (HairCardAtlasSize): [Read-Write] Size of hair card texture atlases

• base_filename (str): [Read-Write] Base filename of generated mesh/texture assets

• base_parent_name (str): [Read-Write] The base name of direct parent LOD level, used for resubdividing geometry or writing to reserved texture layout regions

• card_group_ids (Array[Name]): [Read-Write]

• channel_layout (HairTextureLayout): [Read-Write] Texture layout selected (NOTE: This automatically pulls from group 0)

• depth_maximum (float): [Read-Write] Maximum strand depth value (mapped to 1 in depth texture)

• depth_minimum (float): [Read-Write] Minimum strand depth value (mapped to 0 in depth texture)

• derived_texture_settings_name (str): [Read-Write] The base name of LOD from which texture info/outputs will be pulled (for writing to reserved texture layouts)

• destination_path (DirectoryPath): [Read-Write] Destination content path for generated mesh/texture assets

• filter_group_generation_settings (Array[HairCardGeneratorGroupSettings]): [Read-Write]

• generate_for_groom_group (int32): [Read-Only] The groom group for which geometry will be generated

• generate_geometry_for_all_groups (bool): [Read-Write] Generate geometry for all groom groups on group 0

• hair_widths (Array[float]): [Read-Write]

• intermediate_path (str): [Read-Write]

• lod_index (int32): [Read-Only]

• output_path (str): [Read-Write]

• override_hair_width (bool): [Read-Write]

• random_seed (int32): [Read-Write] Seed value for pseudo-random number generation (set to a specific value for repeatable results)

• reduce_cards_from_previous_lod (bool): [Read-Write] Use previous LOD generated cards and textures but reduce triangle count and flyaways

• reserve_texture_space_lod (int32): [Read-Write] Percentage of texture atlas space to reserve for higher LODs

• root_scales (Array[float]): [Read-Write]

• strand_filter_group_index_map (Array[int32]): [Read-Write]

• tip_scales (Array[float]): [Read-Write]

• use_groom_asset_strand_width (bool): [Read-Write] Use strand width

• use_reserved_space_from_previous_lod (bool): [Read-Write] Place new card textures in reserved space from previous LOD

• uv_smoothing_iterations (int32): [Read-Write] Number of iterations for smoothing strand UVs

• version (str): [Read-Write] Static HCS version number to force regeneration on tool updates

property atlas_size: HairCardAtlasSize

[Read-Only] Size of hair card texture atlases

Type:

(HairCardAtlasSize)

property base_filename: str

[Read-Only] Base filename of generated mesh/texture assets

Type:

(str)

property base_parent_name: str

[Read-Only] The base name of direct parent LOD level, used for resubdividing geometry or writing to reserved texture layout regions

Type:

(str)

property card_group_ids: None

[Read-Only]

Type:

(Array[Name])

property channel_layout: HairTextureLayout

This automatically pulls from group 0)

Type:

(HairTextureLayout)

Type:

[Read-Only] Texture layout selected (NOTE

property depth_maximum: float

[Read-Only] Maximum strand depth value (mapped to 1 in depth texture)

Type:

(float)

property depth_minimum: float

[Read-Only] Minimum strand depth value (mapped to 0 in depth texture)

Type:

(float)

property derived_texture_settings_name: str

[Read-Only] The base name of LOD from which texture info/outputs will be pulled (for writing to reserved texture layouts)

Type:

(str)

property filter_group_generation_settings: None

[Read-Only]

Type:

(Array[HairCardGeneratorGroupSettings])

property generate_for_groom_group: int

[Read-Only] The groom group for which geometry will be generated

Type:

(int32)

property generate_geometry_for_all_groups: bool

[Read-Only] Generate geometry for all groom groups on group 0

Type:

(bool)

property hair_widths: None

[Read-Only]

Type:

(Array[float])

property intermediate_path: str

[Read-Only]

Type:

(str)

property lod_index: int

[Read-Only]

Type:

(int32)

property output_path: str

[Read-Only]

Type:

(str)

property override_hair_width: bool

[Read-Only]

Type:

(bool)

property random_seed: int

[Read-Only] Seed value for pseudo-random number generation (set to a specific value for repeatable results)

Type:

(int32)

property reduce_cards_from_previous_lod: bool

[Read-Only] Use previous LOD generated cards and textures but reduce triangle count and flyaways

Type:

(bool)

property reserve_texture_space_lod: int

[Read-Only] Percentage of texture atlas space to reserve for higher LODs

Type:

(int32)

property root_scales: None

[Read-Only]

Type:

(Array[float])

property strand_filter_group_index_map: None

[Read-Only]

Type:

(Array[int32])

property tip_scales: None

[Read-Only]

Type:

(Array[float])

property use_groom_asset_strand_width: bool

[Read-Only] Use strand width

Type:

(bool)

property use_reserved_space_from_previous_lod: bool

[Read-Only] Place new card textures in reserved space from previous LOD

Type:

(bool)

property uv_smoothing_iterations: int

[Read-Only] Number of iterations for smoothing strand UVs

Type:

(int32)

property version: str

[Read-Only] Static HCS version number to force regeneration on tool updates

Type:

(str)