c4d.modules.hair.HairLibrary¶

class c4d.modules.hair.HairLibrary¶: Hair library class.

Overview¶

Color And Coordinate Utilities
`HairLibrary.BlendColors()`	Blend colors.
`HairLibrary.GetPolyPointST()`	Calculate the s and t coordinates of the point p in the polygon described by pa, pb, pc and pd.
`HairLibrary.MixST()`	Mix by the s and t coordinates among pa, pb, pc and pd.
State And Version
`HairLibrary.GetHairVersion()`	Get the hair version.
`HairLibrary.GetMode()`	Get hair mode.
`HairLibrary.SetMode()`	Set hair mode.

Members¶

Color And Coordinate Utilities¶

HairLibrary.BlendColors(self, mode, colA, colB)¶

Blend colors.

Parameters

mode (int) – Blend mode. (See mhairmaterial.h for modes, e.g. HAIRMATERIAL_BLENDMODE_AVERAGE.)
colA (c4d.Vector) – First color.
colB (c4d.Vector) – Second color.

Return type

c4d.Vector

Returns

Resulting color.

HairLibrary.GetPolyPointST(self, p, pa, pb, pc, pd, bQuad)¶

Calculate the s and t coordinates of the point p in the polygon described by pa, pb, pc and pd.

Parameters

p (c4d.Vector) – Point to get the coordinates for.
pa (c4d.Vector) – First point value.
pb (c4d.Vector) – Second point value.
pc (c4d.Vector) – Third point value.
pd (c4d.Vector) – Fourth point value.
bQuad (bool) – True means quadrangle, False means triangle.

Return type

Tuple[float, float]

Returns

The s and t coordinates.

HairLibrary.MixST(self, s, t, pa, pb, pc, pd, bQuad)¶

Mix by the s and t coordinates among pa, pb, pc and pd.

Parameters

s (float) – S coordinate.
t (float) – T coordinate.
pa (c4d.Vector) – First point value.
pb (c4d.Vector) – Second point value.
pc (c4d.Vector) – Third point value.
pd (c4d.Vector) – Fourth point value.
bQuad (bool) – True means quadrangle, False means triangle.

Return type

Tuple[float, float]

Returns

The s and t coordinates.

State And Version¶

HairLibrary.GetHairVersion(self)¶

Get the hair version.

Return type: int
Returns: Hair version number.

HairLibrary.GetMode(self, doc)¶

Get hair mode.

Parameters

doc (c4d.documents.BaseDocument) – Document.

Return type

int

Returns

Hair mode:

HAIR_MODE_LOCKED	Locked mode
HAIR_MODE_HIDDEN	Hidden mode.
HAIR_MODE_TIPS	Tips mode.
HAIR_MODE_POINTS	Points mode.
HAIR_MODE_GUIDES	Guides mode.
HAIR_MODE_ROOTS	Roots mode.
HAIR_MODE_VERTEX	Vertex mode.

HairLibrary.SetMode(self, doc, mode)¶

Set hair mode.

Parameters

doc (c4d.documents.BaseDocument) – Document.

mode (int) –

New hair mode:

HAIR_MODE_LOCKED	Locked mode
HAIR_MODE_HIDDEN	Hidden mode.
HAIR_MODE_TIPS	Tips mode.
HAIR_MODE_POINTS	Points mode.
HAIR_MODE_GUIDES	Guides mode.
HAIR_MODE_ROOTS	Roots mode.
HAIR_MODE_VERTEX	Vertex mode.

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.