unreal.GroomLibrary

class unreal.GroomLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Groom Blueprint Library

C++ Source:

  • Plugin: HairStrands

  • Module: HairStrandsCore

  • File: GroomBlueprintLibrary.h

classmethod create_new_geometry_cache_groom_binding_asset(groom_asset, geometry_cache, num_interpolation_points=100, source_geometry_cache_for_transfer=None, matching_section=0) GroomBindingAsset

Create a new groom binding asset within the contents space of the project. The asset name will be auto generated based on the groom asset name and the skeletal asset name

Parameters
  • groom_asset (GroomAsset) – Groom asset for binding

  • geometry_cache (GeometryCache) –

  • num_interpolation_points (int32) – (Optional) Number of point used for RBF constraint

  • source_geometry_cache_for_transfer (GeometryCache) –

  • matching_section (int32) –

Return type

GroomBindingAsset

classmethod create_new_geometry_cache_groom_binding_asset_with_path(desired_package_path, groom_asset, geometry_cache, num_interpolation_points=100, source_geometry_cache_for_transfer=None, matching_section=0) GroomBindingAsset

Create a new groom binding asset within the contents space of the project.

Parameters
  • desired_package_path (str) – The package path to use for the groom binding

  • groom_asset (GroomAsset) – Groom asset for binding

  • geometry_cache (GeometryCache) –

  • num_interpolation_points (int32) – Number of point used for RBF constraint (if used)

  • source_geometry_cache_for_transfer (GeometryCache) –

  • matching_section (int32) –

Return type

GroomBindingAsset

classmethod create_new_groom_binding_asset(groom_asset, skeletal_mesh, num_interpolation_points=100, source_skeletal_mesh_for_transfer=None, matching_section=0) GroomBindingAsset

Create a new groom binding asset within the contents space of the project. The asset name will be auto generated based on the groom asset name and the skeletal asset name

Parameters
  • groom_asset (GroomAsset) – Groom asset for binding

  • skeletal_mesh (SkeletalMesh) – Skeletal mesh on which the groom should be bound to

  • num_interpolation_points (int32) – (Optional) Number of point used for RBF constraint

  • source_skeletal_mesh_for_transfer (SkeletalMesh) – (Optional) Skeletal mesh on which the groom was authored. This should be used only if the skeletal mesh on which the groom is attached to, does not match the rest pose of the groom

  • matching_section (int32) –

Return type

GroomBindingAsset

classmethod create_new_groom_binding_asset_with_path(desired_package_path, groom_asset, skeletal_mesh, num_interpolation_points=100, source_skeletal_mesh_for_transfer=None, matching_section=0) GroomBindingAsset

Create a new groom binding asset within the contents space of the project.

Parameters
  • desired_package_path (str) – The package path to use for the groom binding

  • groom_asset (GroomAsset) – Groom asset for binding

  • skeletal_mesh (SkeletalMesh) – Skeletal mesh on which the groom should be bound to

  • num_interpolation_points (int32) – Number of point used for RBF constraint (if used)

  • source_skeletal_mesh_for_transfer (SkeletalMesh) – Skeletal mesh on which the groom was authored. This should be used only if the skeletal mesh on which the groom is attached to, does not match the rest pose of the groom

  • matching_section (int32) –

Return type

GroomBindingAsset