unreal.HairInterpolationSettings

class unreal.HairInterpolationSettings(guide_type: GroomGuideType = Ellipsis, hair_to_guide_density: float = 0.0, rigged_guide_num_curves: int = 0, rigged_guide_num_points: int = 0, interpolation_quality: HairInterpolationQuality = Ellipsis, interpolation_distance: HairInterpolationWeight = Ellipsis, randomize_guide: bool = False, use_unique_guide: bool = False)

Bases: StructBase

Hair Interpolation Settings

C++ Source:

  • Plugin: HairStrands

  • Module: HairStrandsCore

  • File: GroomAssetInterpolation.h

Editor Properties: (see get_editor_property/set_editor_property)

  • guide_type (GroomGuideType): [Read-Write] Type of guides:

    • Imported: use imported guides

    • Generated: generate guides from strands

    • Rigged: generated rigged guides from strands.

  • hair_to_guide_density (float): [Read-Write] Density factor for converting hair into guide curve if no guides are provided. The value should be between 0 and 1, and can be thought as a ratio/percentage of strands used as guides.

  • interpolation_distance (HairInterpolationWeight): [Read-Write] Interpolation distance metric.

  • interpolation_quality (HairInterpolationQuality): [Read-Write] Interpolation data quality.

  • randomize_guide (bool): [Read-Write] Randomize which guides affect a given hair strand.

  • rigged_guide_num_curves (int32): [Read-Write] Number of guides that will be generated on the groom and the skeletal mesh

  • rigged_guide_num_points (int32): [Read-Write] Number of points/bones per generated guide

  • use_unique_guide (bool): [Read-Write] Force a hair strand to be affected by a unique guide.

property guide_type: GroomGuideType

[Read-Write] Type of guides: - Imported: use imported guides - Generated: generate guides from strands - Rigged: generated rigged guides from strands.

Type:

(GroomGuideType)

property hair_to_guide_density: float

[Read-Write] Density factor for converting hair into guide curve if no guides are provided. The value should be between 0 and 1, and can be thought as a ratio/percentage of strands used as guides.

Type:

(float)

property interpolation_distance: HairInterpolationWeight

[Read-Write] Interpolation distance metric.

Type:

(HairInterpolationWeight)

property interpolation_quality: HairInterpolationQuality

[Read-Write] Interpolation data quality.

Type:

(HairInterpolationQuality)

property randomize_guide: bool

[Read-Write] Randomize which guides affect a given hair strand.

Type:

(bool)

property rigged_guide_num_curves: int

[Read-Only] Number of guides that will be generated on the groom and the skeletal mesh

Type:

(int32)

property rigged_guide_num_points: int

[Read-Only] Number of points/bones per generated guide

Type:

(int32)

property use_unique_guide: bool

[Read-Write] Force a hair strand to be affected by a unique guide.

Type:

(bool)