ORNAGUIDES INTERFACE

This interface is used to operate on core guides structure used by Ornatrix. Guides are hair, except that they hold extra data and provide more functions. When using a guide interface you can use "guides.AsHair()" to obtain their hair interface.

Guide interface to any Ornatrix hair object is obtained through "bakedGuides.GetGuides()" command on any baked guides object or other object derived from OrnaGuideHair.

Function reference:

Access to OrnaHair Interface:

.AsHair()
return Interface

Roots:

.SetNumRoots [num] [keep]

.DeleteRootSet [set]
"Deletes a provided set of roots from this structure"

Verts:

.SetNumVerts [num] [keep]

.AppendVerts [verts] [num]
"Appends a number of vertices to the end of vertex array and resizes other data arrays."

.DeleteVertSet [set]

Per-Vertex Data/Channels:

.SetNumVertData [numChans] [keep]
"Sets  number of vertex data channels. This will also resize the vertex data array."

.GetVertData [chan] [ind]
return Float
"Retreives single vertex data for specified channel and vertex."

.SetVertData [chan] [ind] [data]

.GetPointData [chan] [root] [ind]
return Float
"Retreives single vertex [data] for specified channel, root, and vertex."

.SetPointData [chan] [root] [ind] [data]

.SetVertChanName [chan] [name]
"Set the vertex channel name for specified channel. This name appears in the UI."

.GetVertChanName [chan]
return String
"Get the vertex channel name for specified channel. This name appears in the UI."

.DeleteVertChanSet [set]
"Delete a set of channels based on a bit array."

Per-Root Data/Channels:

.SetNumRootData [numChans] [keep]

.GetRootData [chan] [root]
return Float

.SetRootData [chan] [root] [data]

.SetRootChanName [chan] [name]

.GetRootChanName [chan]
return String

.DeleteRootChanSet [set]

.GetRootSel [root]
return Float

.SetRootSel [root] [sel]

.GetWeight [ind]
return Float

.SetWeight [ind] [weight]

Display Flag Access:

.SetDispFlag [flag]

.GetDispFlag [flag]
return Int

.ClearDispFlag [flag]