Difference between revisions of "IC Python API:RLPy RIAvatar"

From Reallusion Wiki!
Jump to: navigation, search
m
m
Line 9: Line 9:
 
=== Inheritance ===
 
=== Inheritance ===
  
−
This class inherits public member functions from:
+
[[IC_Python_API:RLPy_RINode|RINode]] > [[IC_Python_API:RLPy_RIObject|RIObject]] > [[IC_Python_API:RLPy_RIAvatar|RIAvatar]].
−
 
+
−
*[[IC_Python_API:RLPy_RIObject|RLPy.RIObject]]
+
  
 
=== Examples ===
 
=== Examples ===
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar = RLPy.RScene.FindObject( RLPy.EObjectType_Avatar, "Jade" )
 
avatar = RLPy.RScene.FindObject( RLPy.EObjectType_Avatar, "Jade" )
  
Line 74: Line 72:
 
:Failure - RLPy.RStatus.Failure
 
:Failure - RLPy.RStatus.Failure
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar = avatar_list[0]     
 
avatar = avatar_list[0]     
Line 90: Line 88:
 
:Pointer to the Skeleton Component object - [[IC_Python_API:RLPy_RISkeletonComponent|RISkeletonComponent]]
 
:Pointer to the Skeleton Component object - [[IC_Python_API:RLPy_RISkeletonComponent|RISkeletonComponent]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar = avatar_list[0]     
 
avatar = avatar_list[0]     
Line 107: Line 105:
 
:Pointer to the Viseme Component object - [[IC_Python_API:RLPy_RIVisemeComponent|RIVisemeComponent]]
 
:Pointer to the Viseme Component object - [[IC_Python_API:RLPy_RIVisemeComponent|RIVisemeComponent]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar = avatar_list[0]     
 
avatar = avatar_list[0]     
Line 123: Line 121:
 
:Pointer to the Morph Component object - [[IC_Python_API:RLPy_RIMorphComponent|RIMorphComponent]]
 
:Pointer to the Morph Component object - [[IC_Python_API:RLPy_RIMorphComponent|RIMorphComponent]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar = avatar_list[0]     
 
avatar = avatar_list[0]     
Line 139: Line 137:
 
:Pointer to the Material Component object - [[IC_Python_API:RLPy_RIMaterialComponent|RIMaterialComponent]]
 
:Pointer to the Material Component object - [[IC_Python_API:RLPy_RIMaterialComponent|RIMaterialComponent]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar = avatar_list[0]     
 
avatar = avatar_list[0]     
Line 155: Line 153:
 
:Pointer to the HIK Effector Component object - [[IC_Python_API:RLPy_RIHikEffectorComponent|RIHikEffectorComponent]]
 
:Pointer to the HIK Effector Component object - [[IC_Python_API:RLPy_RIHikEffectorComponent|RIHikEffectorComponent]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar = avatar_list[0]     
 
avatar = avatar_list[0]     
Line 171: Line 169:
 
:Pointer to the Face Component object - [[IC_Python_API:RLPy_RIFaceComponent|RIFaceComponent]]
 
:Pointer to the Face Component object - [[IC_Python_API:RLPy_RIFaceComponent|RIFaceComponent]]
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar = avatar_list[0]     
 
avatar = avatar_list[0]     
Line 190: Line 188:
 
:*RLPy.EAvatarGeneration_CC_Game_Base_Multi = 4
 
:*RLPy.EAvatarGeneration_CC_Game_Base_Multi = 4
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar = avatar_list[0]     
 
avatar = avatar_list[0]     
Line 210: Line 208:
 
:*RLPy.EAvatarType_All = 5
 
:*RLPy.EAvatarType_All = 5
  
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python">
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar_list = RLPy.RScene.GetAvatars()
 
avatar = avatar_list[0]     
 
avatar = avatar_list[0]     

Revision as of 23:07, 8 April 2020

Main article: Modules.
Last modified: 04/8/2020

Description

This class provides methods to access all components of a character, for example: RISkeletonComponent, RIVisemeComponent, RIFaceComponent, etc. Retreived component operations are thus available for usage.

Inheritance

RINode > RIObject > RIAvatar.

Examples

avatar = RLPy.RScene.FindObject( RLPy.EObjectType_Avatar, "Jade" )

# set the name of the character
avatar.SetName("new_name")

# Get the name of the character
avatar_name = avatar.GetName()
print(avatar_name) # Jade
 
# Set a Transform key
control = avatar.GetControl("Transform")
transform = RLPy.RTransform.IDENTITY
transform.T().x = 100.0
transform.T().y = 100.0
transform.T().z = 100.0
control.SetValue(RLPy.RTime(0), transform)

# Link and unlink to other objects; iClone Avatar can't set Parent
prop2 = RLPy.RScene.FindObject(RLPy.EObjectType_Prop, "Box2")
result = avatar.LinkTo(prop2, RLPy.RTime(0))
result = avatar.UnLink(RLPy.RTime(0))

# Get the bounds
ret_max = RLPy.RVector3()
ret_center = RLPy.RVector3()
ret_min = RLPy.RVector3()
ret = avatar.GetBounds( ret_max, ret_center, ret_min )
print(ret)

# Get the pivot point
ret_pos = RLPy.RVector3()
ret_rot = RLPy.RVector3()
avatar.GetPivot( ret_pos, ret_rot )
print(ret)

# Clone the character
clone_avatar = avatar.Clone()
print( clone_avatar )

# Check character selection
RLPy.RScene.SelectObject(avatar)
print(avatar.IsSelected()) #True

Member Functions

SetVisible (self, kTime, bVisible )

Set a visibility key by a given time.

Parameters

kTime [IN] Time at which to change visibility - RTime
bVisible [IN] Visibility status - bool

Returns

Success - RLPy.RStatus.Success
Failure - RLPy.RStatus.Failure
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]    
avatar.SetVisible(RLPy.RTime(0), True)
avatar.SetVisible(RLPy.RTime(10), False)

GetSkeletonComponent (self)

Get the character's Skeleton Component, used for retrieving the entire skeleton.

See Also: RISkeletonComponent

Returns

Pointer to the Skeleton Component object - RISkeletonComponent
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]    
skeleton_component = avatar.GetSkeletonComponent()
print(type(_component).__name__)
print(skeleton.GetClipCount())

GetVisemeComponent (self)

Get the character's Viseme Component, which provides operations related to lip-syncing.

See Also: RIVisemeComponent

Returns

Pointer to the Viseme Component object - RIVisemeComponent
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]    
viseme_component  = avatar.GetVisemeComponent()
print(type(viseme_component).__name__)

GetMorphComponent (self)

Get the character's Morph Component, used to edit Morph Animation Keys or retrieve the current morph weighting.

See Also: RIMorphComponent

Returns

Pointer to the Morph Component object - RIMorphComponent
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]    
morph_component  = avatar.GetMorphComponent()
print(type(morph_component).__name__)

GetMaterialComponent (self)

Get the character's Material Component, used for setting material related parameter values.

See Also: RIMaterialComponent

Returns

Pointer to the Material Component object - RIMaterialComponent
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]    
material_component  = avatar.GetMaterialComponent()
print(type(material_component).__name__)

GetHikEffectorComponent (self)

Get the character's HIK Effector Component, used for controlling and managing the IK skeleton.

See Also: RIHikEffectorComponent

Returns

Pointer to the HIK Effector Component object - RIHikEffectorComponent
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]    
material_component  = avatar.GetMaterialComponent()
print(type(material_component).__name__)

GetFaceComponent (self)

Get the Face Component for the character. Face Component is used to control the facial and head settings for the character.

See Also: RIFaceComponent

Returns

Pointer to the Face Component object - RIFaceComponent
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]    
face_component  = avatar.GetFaceComponent()
print(type(face_component).__name__)

GetGeneration (self)

Get the CC avatar standard generation for the character.

Returns

Character Creator Avatar generation - enum
  • RLPy.EAvatarGeneration_None = 0
  • RLPy.EAvatarGeneration_CC_G1_Avatar = 1
  • RLPy.EAvatarGeneration_CC_G3_Avatar = 2
  • RLPy.EAvatarGeneration_CC_Game_Base_One = 3
  • RLPy.EAvatarGeneration_CC_Game_Base_Multi = 4
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]    
avatar_generation = avatar.GetGeneration()
print(avatar_generation)

GetAvatarType (self)

Get the character's avatar type.

Returns

Avatar Type - enum
  • RLPy.EAvatarType_None = 0
  • RLPy.EAvatarType_Standard = 1
  • RLPy.EAvatarType_NonStandard = 2
  • RLPy.EAvatarType_NonHuman = 3
  • RLPy.EAvatarType_StandardSeries = 4
  • RLPy.EAvatarType_All = 5
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]    
avatr_type = avatar.GetAvatarType()
print(avatr_type == RLPy.EAvatarType_StandardSeries)
Retrieved from "http://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RIAvatar&oldid=4474"