View source for IC8 Python API:RLPy RIFaceComponent

{{TOC}}
{{Parent|IC_8_Python_API:Modules|iC8 Modules}}
{{last_modified}}

==Description==


This class is mainly used to set up the character's facial and head controls.  [[IC_Python_API:RLPy_RIFaceComponent|RIFaceComponent]] data include 12 facial bones, 60 facial morphs and 24 custom morphs.  You can open the details panel in the Face Puppet interface and press '''Ctrl+F2''' to display more detailed data. The numbered data in the front are the 60 morphs data, the next are 12 facial bones data, while the rest belong to the custom set. A few of the bones within the 12 facial bones have no effect.  You can tell if it has no effect, therefore invalid, if the data name is marked "N/A".  In addition, an expression clip needs to be set up in order to create expression keys. 

==Class Methods==

===RLPy.RIFaceComponent.AddClip(self, kTime, strName, kLength)===
Add facial clip.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>kTime[IN]</b> The time at which to add the clip - RLPy.RLTime
::<b>strName[IN]</b> Clip name - string
::<b>kLength[IN]</b> Clip length - RLPy.RLTime

====Returns====
::<b>RLPy.RStatus.Success</b> - Success
::<b>RLPy.RStatus.Failure</b> - Fail

<syntaxhighlight lang="python" line>
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]
face_component = avatar.GetFaceComponent()

result = face_component.AddClip(RLPy.RTime(0), "Clip", RLPy.RTime(10))
print(result)
</syntaxhighlight>

===RLPy.RIFaceComponent.AddExpressionKeys(self, kTime, kExpressions, kStrengths, kInterval)===
Add an expression key.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>kTime[IN]</b> The time at which to add the key - RLPy.RLTime
::<b>kExpressions[IN]</b> Name of the expressions - string
::<b>kStrengths[IN]</b> The strength of expressions. The size of the kStrengths must be a multiple of kExpressions - float
::<b>kInterval[IN]</b> Time interval. When kStrengths is greater than kExpressions, the key will be downloaded at this interval. ex. len( kExp)== 10, len( kStrengths)= 30, kTime = 1000, kInterval = 2000, the result will be: Add keys at the time = 1000, values are kStrengths[0~9], Add keys at the time = 1000 + 2000, values are kStrengths[10~19], Add keys at the time = 1000 + 2000 + 2000, values are kStrengths[20~29], - RLPy.RLTime

====Returns====
::<b>RLPy.RStatus.Success</b> - Success
::<b>RLPy.RStatus.Failure</b> - Fail

<syntaxhighlight lang="python" line>
#No example
</syntaxhighlight>

===RLPy.RIFaceComponent.AddExpressivenessKey(self, kTime, fWeight)===
Add an expressiveness key.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>kTime[IN]</b> The time at which to add the key - RLPy.RLTime
::<b>fWeight[IN]</b> The strength of expressiveness - float

====Returns====
::<b>RLPy.RStatus.Success</b> - Success
::<b>RLPy.RStatus.Failure</b> - Fail

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.BeginKeyEditing(self)===
Start to add expression key.

<span style="background:orange; color:white"><b>Experimental API</b></span>
<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.BreakClip(self, kTime)===
Break the clip at that time according to the specified time.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>kTime[IN]</b> specified time - RLPy.RLTime

====Returns====
::<b>RLPy.RStatus.Success</b> - Success
::<b>RLPy.RStatus.Failure</b> - Fail

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.DeleteClip(self, spClip)===
delete the clip.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>kTimespClip[IN]</b> specified clip.

====Returns====
::<b>RLPy.RStatus.Success</b> - Success
::<b>RLPy.RStatus.Failure</b> - Fail

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.EndKeyEditing(self)===
End to add expression key.

<span style="background:orange; color:white"><b>Experimental API</b></span>
<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetAutoBlinkName(self)===
Get the current setting of auto-blink.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Returns====
auto-blink dispaly name - string 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetAutoBlinkNames(self)===
Get the display name list of auto-blink.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Returns====
The name list of autoblink, ex: None, Normal, Nervous - string 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetClip(self, uIndex)===
Get facial clip.

====Parameters====
::<b>uIndex[IN]</b> Index of the clip - int

====Returns====
Pointer to the clip - RLPy.RIClip 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetClipByTime(self, kHitTime)===
Get facial clip.

====Parameters====
::<b>kHitTime[IN]</b> time during clip range - RLPy.RLTime

====Returns====
Pointer to the clip - RLPy.RIClip 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetClipCount(self)===
Get number of facial clips.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Returns====
Number of facial clips - int 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetExpressionGroups(self)===
Get the name list of expression group.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Returns====
facial group list ex:["Brow","Eye","Nose"....] - string 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetExpressionNames(self, strType, bMocapOrder = False)===
Get the name list of expression.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>strType[IN]</b> type name. ex: "Custom", - string
::<b>bMocapOrder[IN]</b> if true, it will return the order of expression for facial mocap RIFacialDevice::ProcessData() - bool

====Returns====
The name list of expression - string 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetExpressionSetUid(self)===
Get id of the expression set.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Returns====
uid - string 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetExpressionStatuses(self, strType)===
Get the status list of expression data.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>strType[IN]</b> type name. ex: "Custom" - string

====Returns====
The status list of facial expression data - list 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetExpressionWeights(self, args)===
Get weights of the expression.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>kTime[IN]</b> The time at which to get the weight - RLPy.RLTime
::<b>kHead[IN]</b> The name list of the expression. it will return all expression weights while the input list is empty.

====Returns====
weightlist of the expression

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetExpressiveness(self, kTime)===
Get weights of the expressiveness.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>kTime[IN]</b> The time at which to get the weight - RLPy.RLTime

====Returns====
weightof the expressiveness

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.GetStrength(self)===
Get the strength of facial animation.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Returns====
The value of strength - float 

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>

===RLPy.RIFaceComponent.SetAutoBlinkName(self, strName)===
Set the current setting of auto-blink.

<span style="background:orange; color:white"><b>Experimental API</b></span>

====Parameters====
::<b>nIndex[IN]</b> auto-blink display name

====Returns====
::<b>RLPy.RStatus.Success</b> - Success
::<b>RLPy.RStatus.Failure</b> - Fail

<syntaxhighlight lang="python" line>
# No example
</syntaxhighlight>