Documentation / loaders / ZHairConvertOptions

Type Alias: ZHairConvertOptions

ZHairConvertOptions = object

Defined in: libs/loaders/src/curves/zhair_convert.ts:30

Options for converting a curve archive.

Properties

unitScale?

optional unitScale?: number

Defined in: libs/loaders/src/curves/zhair_convert.ts:40

Scale recorded in the file, converting its units to metres.

Remarks

Defaults per format: Alembic to 0.01, because Maya authors in centimetres; .hair to 1, because the format records no unit at all and any other guess would be arbitrary. Positions are stored unscaled either way, so this stays adjustable after import.

---

upAxis?

optional upAxis?: StrandUpAxis

Defined in: libs/loaders/src/curves/zhair_convert.ts:48

Up axis of a .hair file's points.

Remarks

cyHairFile models are conventionally Z-up, which is the default. Ignored for Alembic, which carries its own orientation.

---

originAnchor?

optional originAnchor?: Nullable<StrandOriginAnchor>

Defined in: libs/loaders/src/curves/zhair_convert.ts:60

Point of the groom's bounding box to move onto the origin.

Remarks

Null or absent leaves the control points where the archive put them, which is the historical behaviour. A groom combed in place carries the offset its character had in the authoring scene, so an archive that looks fine in Maya can arrive tens of units from its own origin; anchoring it makes the node's transform mean what it says. Applied after the up-axis conversion, so the anchor's axes are the engine's rather than the source's.

---

sourcePath?

optional sourcePath?: string

Defined in: libs/loaders/src/curves/zhair_convert.ts:62

Path recorded in the file so it can be traced back to its source.