unreal.HairCardGenControllerBase

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

Bases: Object

Hair Card Gen Controller Base

C++ Source:

• Plugin: HairCardGenerator

• Module: HairCardGeneratorEditor

• File: HairCardGenControllerBase.h

cluster_textures(group_id, geom_data, mesh_data) → HairCardTextureClusterData or None

Pure compute. Returns texture cluster assignment via OutClusterData (bool-first + pure-out).

Parameters:

• group_id (int32)

• geom_data (HairCardGeomData)

• mesh_data (HairCardMeshData)

Returns:

out_cluster_data (HairCardTextureClusterData):

Return type:

HairCardTextureClusterData or None

create_cards_static_mesh(static_mesh, verts, faces, normals, uvs, groups) → None

Helper C++ function for building a static mesh from verts/faces, etc.

Parameters:

• static_mesh (StaticMesh)

• verts (Array[float])

• faces (Array[int32])

• normals (Array[float])

• uvs (Array[float])

• groups (Array[int32])

generate_cards_geometry() → (out_geom_data=HairCardGeomData, out_mesh_data=HairCardMeshData, out_card_count=int32) or None

Pure compute. Returns card geometry via OutGeomData (bool-first + pure-out).

Returns:

out_geom_data (HairCardGeomData):

out_mesh_data (HairCardMeshData):

out_card_count (int32):

Return type:

tuple or None

generate_clumps(group_id) → HairCardClumpData or None

Pure compute. Returns clump assignment via OutClumpData (bool-first + pure-out).

Parameters:

group_id (int32)

Returns:

out_clump_data (HairCardClumpData):

Return type:

HairCardClumpData or None

generate_mesh(static_mesh, all_geom_data, all_mesh_data, all_cluster_data, layout_data) → bool

Pure compute. Writes the static mesh asset.

Parameters:

• static_mesh (StaticMesh)

• all_geom_data (Array[HairCardGeomData])

• all_mesh_data (Array[HairCardMeshData])

• all_cluster_data (Array[HairCardTextureClusterData])

• layout_data (HairCardAtlasLayoutData)

Return type:

bool

generate_texture_atlases(all_geom_data, all_mesh_data, all_cluster_data, layout_data, binpack_data, width_scale) → bool

Pure compute. Renders texture atlases to disk.

Parameters:

• all_geom_data (Array[HairCardGeomData])

• all_mesh_data (Array[HairCardMeshData])

• all_cluster_data (Array[HairCardTextureClusterData])

• layout_data (HairCardAtlasLayoutData)

• binpack_data (HairCardAtlasBinpackData)

• width_scale (float)

Return type:

bool

generate_texture_layout(all_geom_data, all_mesh_data, all_cluster_data) → (out_layout_data=HairCardAtlasLayoutData, out_binpack_data=HairCardAtlasBinpackData, out_atlas_uv_data=HairCardAtlasUVData) or None

Pure compute. Receives all-group data; returns atlas layout and per-vertex atlas UVs (bool-first + pure-out).

Parameters:

• all_geom_data (Array[HairCardGeomData])

• all_mesh_data (Array[HairCardMeshData])

• all_cluster_data (Array[HairCardTextureClusterData])

Returns:

out_layout_data (HairCardAtlasLayoutData):

out_binpack_data (HairCardAtlasBinpackData):

out_atlas_uv_data (HairCardAtlasUVData):

Return type:

tuple or None

get_average_curve(id, cid) → Array[float]

Get Average Curve

Parameters:

• id (int32)

• cid (int32)

Return type:

Array[float]

get_num_cards_per_clump() → Array[int32]

Returns num sub-cards per clump optimizer; available after SetOptimizations.

Return type:

Array[int32]

get_points_per_curve() → int32

Get Points Per Curve

Return type:

int32

load_atlas_binpack_data() → HairCardAtlasBinpackData or None

Load Atlas Binpack Data

Returns:

out_binpack_data (HairCardAtlasBinpackData):

Return type:

HairCardAtlasBinpackData or None

load_atlas_layout_data() → HairCardAtlasLayoutData or None

Load Atlas Layout Data

Returns:

out_layout_data (HairCardAtlasLayoutData):

Return type:

HairCardAtlasLayoutData or None

load_card_data(group_id) → (out_geom_data=HairCardGeomData, out_mesh_data=HairCardMeshData, out_card_count=int32) or None

Load Card Data

Parameters:

group_id (int32)

Returns:

out_geom_data (HairCardGeomData):

out_mesh_data (HairCardMeshData):

out_card_count (int32):

Return type:

tuple or None

load_clump_data(group_id) → HairCardClumpData or None

Load Clump Data

Parameters:

group_id (int32)

Returns:

out_clump_data (HairCardClumpData):

Return type:

HairCardClumpData or None

load_groom_data(groom_data, name, cached_grooms_path, save_cached) → bool

Load Groom Data

Parameters:

• groom_data (HairCardGen_GroomData)

• name (str)

• cached_grooms_path (str)

• save_cached (bool)

Return type:

bool

load_settings(generator_settings) → bool

Load Settings

Parameters:

generator_settings (HairCardGeneratorPluginSettings)

Return type:

bool

load_texture_cluster_data(group_id) → HairCardTextureClusterData or None

Load Texture Cluster Data

Parameters:

group_id (int32)

Returns:

out_tex_cluster_data (HairCardTextureClusterData):

Return type:

HairCardTextureClusterData or None

save_atlas_binpack_data(binpack_data) → bool

Save Atlas Binpack Data

Parameters:

binpack_data (HairCardAtlasBinpackData)

Return type:

bool

save_atlas_layout_data(layout_data) → bool

Save Atlas Layout Data

Parameters:

layout_data (HairCardAtlasLayoutData)

Return type:

bool

save_card_data(group_id, geometry_data, mesh_data, card_count) → bool

Save Card Data

Parameters:

• group_id (int32)

• geometry_data (HairCardGeomData)

• mesh_data (HairCardMeshData)

• card_count (int32)

Return type:

bool

save_clump_data(group_id, clump_data) → bool

—- Save / Load ufunctions —-

Parameters:

• group_id (int32)

• clump_data (HairCardClumpData)

Return type:

bool

save_texture_cluster_data(group_id, tex_cluster_data) → bool

Save Texture Cluster Data

Parameters:

• group_id (int32)

• tex_cluster_data (HairCardTextureClusterData)

Return type:

bool

set_interpolated_avg_curve(id, cid, points) → None

Set Interpolated Avg Curve

Parameters:

• id (int32)

• cid (int32)

• points (Array[float])

set_optimizations(group_id, clump_data) → bool

Pure compute. Builds in-memory geometry_opt state from clump data.

Parameters:

• group_id (int32)

• clump_data (HairCardClumpData)

Return type:

bool