Editor.Components.HairVisual
ClassRenders and simulates hair with physics, collision, and material properties.
Index
Properties
- bendStiffness
- clumpDensity
- clumpRadius
- clumpTipScale
- collapseStiffness
- colliders
- collisionEnabled
- collisionFriction
- collisionOffset
- collisionStiffness
- damp
- debugDrawLoadedStrands
- debugDrawSimulatedStrands
- debugModeEnabled
- density
- enabled
- fallbackModeEnabled
- frameRate
- friction
- gravity
- hairData
- hairMaterial
- hairResolution
- hasPrefabChanges
- horizontalAlignment
- id
- isPrefabInstanceRoot
- meshShadowMode
- meta
- name
- noise
- renderOrder
- sceneObject
- selfCollisionEnabled
- selfCollisionFriction
- selfCollisionOffset
- selfCollisionStiffness
- shadowColor
- shadowDensity
- steppedCutEnabled
- stiffness
- strandCut
- strandNeighborCosThreshold
- strandNeighborLengthThreshold
- strandNeighborRadius
- strandTaper
- strandWidth
- stretchLimitEnabled
- stretchMode
- stretchStiffness
- twistStiffness
- type
- verticalAlignment
- windEnabled
- windForce
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const scene = model.project.scene;
// HairVisual renders strand-based hair simulation. It needs a
// HairDataAsset (hair grooming data, typically authored in a DCC tool
// and imported into the project) assigned before it draws anything;
// the values below just configure the simulation parameters.
const obj = scene.createSceneObject('HairObj');
const hair = obj.addComponent('HairVisual') as Editor.Components.HairVisual;
hair.gravity = new vec3(0, -9.8, 0);
hair.stiffness = 0.5;
hair.bendStiffness = 0.3;
hair.stretchStiffness = 0.8;
hair.friction = 0.4;
hair.strandWidth = 0.002;
hair.density = 100;
hair.windEnabled = true;
hair.windForce = new vec3(1, 0, 0);
console.log(`HairVisual configured: stiffness=${hair.stiffness}, density=${hair.density}`);
Extends
Properties
bendStiffness
bendStiffness:
number
Resistance to bending deformation.
clumpDensity
clumpDensity:
number
Density of hair clumping.
clumpRadius
clumpRadius:
number
Radius defining the area for hair clumping.
clumpTipScale
clumpTipScale:
number
Scale factor applied to clump tips.
collapseStiffness
collapseStiffness:
number
Resistance to strand collapse.
colliders
colliders:
ColliderComponent[]
Physics colliders that hair collides with.
collisionEnabled
collisionEnabled:
boolean
Whether hair collides with external objects.
collisionFriction
collisionFriction:
number
Friction coefficient for collisions with external objects.
collisionOffset
collisionOffset:
number
Distance offset for collision detection.
collisionStiffness
collisionStiffness:
number
Stiffness applied when hair collides with external objects.
damp
damp:
number
Damping factor for hair movement.
debugDrawLoadedStrands
debugDrawLoadedStrands:
boolean
Whether loaded hair strands are visualized in debug mode.
debugDrawSimulatedStrands
debugDrawSimulatedStrands:
boolean
Whether simulated hair strands are visualized in debug mode.
debugModeEnabled
debugModeEnabled:
boolean
Whether debug visualization is enabled.
density
density:
number
Hair strand density.
enabled
enabled:
boolean
Whether the component is active.
Inherited from
fallbackModeEnabled
fallbackModeEnabled:
boolean
Whether fallback rendering is used when simulation is unavailable.
frameRate
frameRate:
number
Simulation update rate in frames per second.
friction
friction:
number
Friction applied to hair movement.
gravity
gravity:
vec3
Gravitational acceleration vector affecting hair.
hairData
hairData:
HairDataAsset
Hair geometry and strand data asset.
hairMaterial
hairMaterial:
Material
Material applied to rendered hair.
hairResolution
hairResolution:
number
Resolution of hair simulation.
hasPrefabChanges
readonlyhasPrefabChanges:boolean
Whether this entity differs from its counterpart in the prefab or was added to the prefab instance. Always false outside prefab instances.
Inherited from
BaseMeshVisual.hasPrefabChanges
horizontalAlignment
horizontalAlignment:
Horizontal
Horizontal alignment of the mesh visual.
Inherited from
BaseMeshVisual.horizontalAlignment
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
isPrefabInstanceRoot
readonlyisPrefabInstanceRoot:boolean
Whether this entity is the root of a prefab instance.
Inherited from
BaseMeshVisual.isPrefabInstanceRoot
meshShadowMode
meshShadowMode:
MeshShadowMode
Shadow rendering mode for the mesh.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
name:
string
Name of the component.
Inherited from
noise
noise:
number
Noise amplitude applied to hair movement.
renderOrder
renderOrder:
number
Determines the order in which this visual component is rendered relative to others.
Inherited from
sceneObject
readonlysceneObject:SceneObject
Scene object this component is attached to.
Inherited from
selfCollisionEnabled
selfCollisionEnabled:
boolean
Whether hair-to-hair collisions are enabled.
selfCollisionFriction
selfCollisionFriction:
number
Friction coefficient for hair-to-hair collisions.
selfCollisionOffset
selfCollisionOffset:
number
Distance offset for self-collision detection.
selfCollisionStiffness
selfCollisionStiffness:
number
Stiffness applied when hair collides with itself.
shadowColor
shadowColor:
vec4
Color of the mesh shadow.
Inherited from
shadowDensity
shadowDensity:
number
Opacity of the mesh shadow.
Inherited from
steppedCutEnabled
steppedCutEnabled:
boolean
Whether stepped hair cutting is enabled.
stiffness
stiffness:
number
Overall hair strand stiffness.
strandCut
strandCut:
number
Length cut from each hair strand.
strandNeighborCosThreshold
strandNeighborCosThreshold:
number
Cosine angle threshold for neighbor strand interactions.
strandNeighborLengthThreshold
strandNeighborLengthThreshold:
number
Length threshold for neighbor strand interactions.
strandNeighborRadius
strandNeighborRadius:
number
Search radius for neighboring strands.
strandTaper
strandTaper:
number
Taper factor for hair strand width along length.
strandWidth
strandWidth:
number
Width of individual hair strands.
stretchLimitEnabled
stretchLimitEnabled:
boolean
Whether stretching limits on hair strands are enforced.
stretchMode
stretchMode:
StretchMode
How the mesh stretches to fit its container.
Inherited from
stretchStiffness
stretchStiffness:
number
Resistance to strand stretching.
twistStiffness
twistStiffness:
number
Resistance to strand twisting.
type
readonlytype:string
The entity's type.
Inherited from
verticalAlignment
verticalAlignment:
Vertical
Vertical alignment of the mesh visual.
Inherited from
BaseMeshVisual.verticalAlignment
windEnabled
windEnabled:
boolean
Whether wind force effects are applied.
windForce
windForce:
vec3
Wind acceleration vector affecting hair.
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
BaseMeshVisual.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
BaseMeshVisual.getOwnedEntities
getPrefabInstanceRoot()
getPrefabInstanceRoot():
Prefabable
Returns the nearest prefab instance root that contains this entity, starting with the entity itself, or null if it is not part of a prefab instance.
Returns
Inherited from
BaseMeshVisual.getPrefabInstanceRoot
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean