unreal.HairGroupDesc

class unreal.HairGroupDesc(hair_width=0.1, hair_width_override=False, hair_root_scale=1.0, hair_root_scale_override=False, hair_tip_scale=1.0, hair_tip_scale_override=False, hair_shadow_density=1.0, hair_shadow_density_override=False, hair_raytracing_radius_scale=1.0, hair_raytracing_radius_scale_override=False, use_hair_raytracing_geometry=False, use_hair_raytracing_geometry_override=False, lod_bias=0.0, use_stable_rasterization=False, use_stable_rasterization_override=False, scatter_scene_lighting=False, scatter_scene_lighting_override=False, hair_length_scale=1.0, hair_length_scale_override=False)

Bases: unreal.StructBase

Note: If a new field is added to this struct, think to update GroomComponentDestailsCustomization.cpp to handle override flags

C++ Source:

  • Plugin: HairStrands

  • Module: HairStrandsCore

  • File: GroomDesc.h

Editor Properties: (see get_editor_property/set_editor_property)

  • hair_length_scale (float): [Read-Write] Hair Length Scale: When enabled, Length Scale allow to scale the length of the hair.

  • hair_length_scale_override (bool): [Read-Write] Hair Length Scale Override

  • hair_raytracing_radius_scale (float): [Read-Write] Hair Raytracing Radius Scale: Scale the hair geometry radius for ray tracing effects (e.g. shadow)

  • hair_raytracing_radius_scale_override (bool): [Read-Write] Hair Raytracing Radius Scale Override

  • hair_root_scale (float): [Read-Write] Hair Root Scale: Scale the hair width at the root

  • hair_root_scale_override (bool): [Read-Write] Hair Root Scale Override

  • hair_shadow_density (float): [Read-Write] Hair Shadow Density: Override the hair shadow density factor (unit less).

  • hair_shadow_density_override (bool): [Read-Write] Hair Shadow Density Override

  • hair_tip_scale (float): [Read-Write] Hair Tip Scale: Scale the hair with at the tip

  • hair_tip_scale_override (bool): [Read-Write] Hair Tip Scale Override

  • hair_width (float): [Read-Write] Hair Width: Hair width (in centimeters)

  • hair_width_override (bool): [Read-Write] Hair Width Override

  • lod_bias (float): [Read-Write] LODBias: Bias the selected LOD. A value >0 will progressively select lower detailed lods. Used when r.HairStrands.Cluster.Culling = 1.

  • scatter_scene_lighting (bool): [Read-Write] Scatter Scene Lighting: Light hair with the scene color. This is used for vellus/short hair to bring light from the surrounding surface, like skin.

  • scatter_scene_lighting_override (bool): [Read-Write] Scatter Scene Lighting Override

  • use_hair_raytracing_geometry (bool): [Read-Write] Use Hair Raytracing Geometry: Enable hair strands geomtry for raytracing

  • use_hair_raytracing_geometry_override (bool): [Read-Write] Use Hair Raytracing Geometry Override

  • use_stable_rasterization (bool): [Read-Write] Use Stable Rasterization: Insure the hair does not alias. When enable, group of hairs might appear thicker. Isolated hair should remain thin.

  • use_stable_rasterization_override (bool): [Read-Write] Use Stable Rasterization Override

property hair_length_scale

[Read-Write] Hair Length Scale: When enabled, Length Scale allow to scale the length of the hair.

Type

(float)

property hair_length_scale_override

[Read-Write] Hair Length Scale Override

Type

(bool)

property hair_raytracing_radius_scale

[Read-Write] Hair Raytracing Radius Scale: Scale the hair geometry radius for ray tracing effects (e.g. shadow)

Type

(float)

property hair_raytracing_radius_scale_override

[Read-Write] Hair Raytracing Radius Scale Override

Type

(bool)

property hair_root_scale

[Read-Write] Hair Root Scale: Scale the hair width at the root

Type

(float)

property hair_root_scale_override

[Read-Write] Hair Root Scale Override

Type

(bool)

property hair_shadow_density

[Read-Write] Hair Shadow Density: Override the hair shadow density factor (unit less).

Type

(float)

property hair_shadow_density_override

[Read-Write] Hair Shadow Density Override

Type

(bool)

property hair_tip_scale

[Read-Write] Hair Tip Scale: Scale the hair with at the tip

Type

(float)

property hair_tip_scale_override

[Read-Write] Hair Tip Scale Override

Type

(bool)

property hair_width

[Read-Write] Hair Width: Hair width (in centimeters)

Type

(float)

property hair_width_override

[Read-Write] Hair Width Override

Type

(bool)

property lod_bias

[Read-Write] LODBias: Bias the selected LOD. A value >0 will progressively select lower detailed lods. Used when r.HairStrands.Cluster.Culling = 1.

Type

(float)

property scatter_scene_lighting

[Read-Only] Scatter Scene Lighting: Light hair with the scene color. This is used for vellus/short hair to bring light from the surrounding surface, like skin.

Type

(bool)

property scatter_scene_lighting_override

[Read-Write] Scatter Scene Lighting Override

Type

(bool)

property use_hair_raytracing_geometry

[Read-Write] Use Hair Raytracing Geometry: Enable hair strands geomtry for raytracing

Type

(bool)

property use_hair_raytracing_geometry_override

[Read-Write] Use Hair Raytracing Geometry Override

Type

(bool)

property use_stable_rasterization

[Read-Only] Use Stable Rasterization: Insure the hair does not alias. When enable, group of hairs might appear thicker. Isolated hair should remain thin.

Type

(bool)

property use_stable_rasterization_override

[Read-Write] Use Stable Rasterization Override

Type

(bool)