IC Python API:RLPy RIHikEffectorComponent
- Main article: Modules.
Inheritance
This class inherits public member functions from:
Detailed Description
This class is the interface to the human IK effector in the avatar.
( Experimental Class )# Get human IK component
avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]
hik_effector_component = avatar.GetHikEffectorComponent()
# Activate left hand effector
hik_effector_component.ActivateEffector(RLPy.EHikEffector_LeftHand)
print(hik_effector_component.GetEffectorActive(RLPy.EHikEffector_LeftHand))
# Process left hand data to effector
pos_1 = RLPy.RVector3.UNIT_X
pos_2 = RLPy.RVector3.UNIT_Y
position_data = [pos_1, pos_2]
result = hik_effector_component.ProcessEffector(position_data)
print(result)
Member Functions
ActivateEffector
RLPy.RIHikEffectorComponent.ActivateEffector ( self, args )
Activate human IK effector with lock translate and rotate status. ( Experimental API )
Parameters
eEffector [IN] Human IK effector - RLPy.EHikEffector
- RLPy.EHikEffector_Invalid
- RLPy.EHikEffector_LeftHand
- RLPy.EHikEffector_LeftElbow
- RLPy.EHikEffector_LeftShoulder
- RLPy.EHikEffector_RightHand
- RLPy.EHikEffector_RightElbow
- RLPy.EHikEffector_RightShoulder
- RLPy.EHikEffector_LeftFoot
- RLPy.EHikEffector_LeftKnee
- RLPy.EHikEffector_LeftHip
- RLPy.EHikEffector_RightFoot
- RLPy.EHikEffector_RightKnee
- RLPy.EHikEffector_RightHip
- RLPy.EHikEffector_Hip
- RLPy.EHikEffector_Head
- RLPy.EHikEffector_Neck
- RLPy.EHikEffector_ChestOrigin
- RLPy.EHikEffector_LeftToe
- RLPy.EHikEffector_RightToe
- RLPy.EHikEffector_LeftFingerBase
- RLPy.EHikEffector_RightFingerBase
- RLPy.EHikEffector_Quantity
bLockTranslate [IN] Lock translate status - bool
bLockRotate [IN] Lock rotate status - bool
Return Values
RLPy.RStatus.Success Success
RLPy.RStatus.Failure Fail
DeactivateEffector
RLPy.RIHikEffectorComponent.DeactivateEffector ( self, eEffector )
Deactivate human IK effector. ( Experimental API )
Parameters
eEffector [IN] Human IK effector - RLPy.EHikEffector
- RLPy.EHikEffector_Invalid
- RLPy.EHikEffector_LeftHand
- RLPy.EHikEffector_LeftElbow
- RLPy.EHikEffector_LeftShoulder
- RLPy.EHikEffector_RightHand
- RLPy.EHikEffector_RightElbow
- RLPy.EHikEffector_RightShoulder
- RLPy.EHikEffector_LeftFoot
- RLPy.EHikEffector_LeftKnee
- RLPy.EHikEffector_LeftHip
- RLPy.EHikEffector_RightFoot
- RLPy.EHikEffector_RightKnee
- RLPy.EHikEffector_RightHip
- RLPy.EHikEffector_Hip
- RLPy.EHikEffector_Head
- RLPy.EHikEffector_Neck
- RLPy.EHikEffector_ChestOrigin
- RLPy.EHikEffector_LeftToe
- RLPy.EHikEffector_RightToe
- RLPy.EHikEffector_LeftFingerBase
- RLPy.EHikEffector_RightFingerBase
- RLPy.EHikEffector_Quantity
Return Values
RLPy.RStatus.Success Success
RLPy.RStatus.Failure Fail
GetActivatedEffector
RLPy.RIHikEffectorComponent.GetActivatedEffector ( self )
Get activated human IK effector. ( Experimental API )
Returns
Activated human IK effector - int
GetEffectorActive
RLPy.RIHikEffectorComponent.GetEffectorActive ( self, eEffector )
Get human IK effector active status. ( Experimental API )
Parameters
eEffector [IN] Human IK effector - RLPy.EHikEffector
- RLPy.EHikEffector_Invalid
- RLPy.EHikEffector_LeftHand
- RLPy.EHikEffector_LeftElbow
- RLPy.EHikEffector_LeftShoulder
- RLPy.EHikEffector_RightHand
- RLPy.EHikEffector_RightElbow
- RLPy.EHikEffector_RightShoulder
- RLPy.EHikEffector_LeftFoot
- RLPy.EHikEffector_LeftKnee
- RLPy.EHikEffector_LeftHip
- RLPy.EHikEffector_RightFoot
- RLPy.EHikEffector_RightKnee
- RLPy.EHikEffector_RightHip
- RLPy.EHikEffector_Hip
- RLPy.EHikEffector_Head
- RLPy.EHikEffector_Neck
- RLPy.EHikEffector_ChestOrigin
- RLPy.EHikEffector_LeftToe
- RLPy.EHikEffector_RightToe
- RLPy.EHikEffector_LeftFingerBase
- RLPy.EHikEffector_RightFingerBase
- RLPy.EHikEffector_Quantity
Returns
True if human IK effector is active, False if human IK effector is not active - bool
GetEffectorLockRotate
RLPy.RIHikEffectorComponent.GetEffectorLockRotate ( self, eEffector )
Get human IK effector lock rotate status. ( Experimental API )
Parameters
eEffector [IN] Human IK effector - RLPy.EHikEffector
- RLPy.EHikEffector_Invalid
- RLPy.EHikEffector_LeftHand
- RLPy.EHikEffector_LeftElbow
- RLPy.EHikEffector_LeftShoulder
- RLPy.EHikEffector_RightHand
- RLPy.EHikEffector_RightElbow
- RLPy.EHikEffector_RightShoulder
- RLPy.EHikEffector_LeftFoot
- RLPy.EHikEffector_LeftKnee
- RLPy.EHikEffector_LeftHip
- RLPy.EHikEffector_RightFoot
- RLPy.EHikEffector_RightKnee
- RLPy.EHikEffector_RightHip
- RLPy.EHikEffector_Hip
- RLPy.EHikEffector_Head
- RLPy.EHikEffector_Neck
- RLPy.EHikEffector_ChestOrigin
- RLPy.EHikEffector_LeftToe
- RLPy.EHikEffector_RightToe
- RLPy.EHikEffector_LeftFingerBase
- RLPy.EHikEffector_RightFingerBase
- RLPy.EHikEffector_Quantity
Returns
True if human IK effector rotate status is locked, False if human IK effector rotate is unlocked - bool
GetEffectorLockTranslate
RLPy.RIHikEffectorComponent.GetEffectorLockTranslate ( self, eEffector )
Get human IK effector lock translate status. ( Experimental API )
Parameters
eEffector [IN] Human IK effector - RLPy.EHikEffector
- RLPy.EHikEffector_Invalid
- RLPy.EHikEffector_LeftHand
- RLPy.EHikEffector_LeftElbow
- RLPy.EHikEffector_LeftShoulder
- RLPy.EHikEffector_RightHand
- RLPy.EHikEffector_RightElbow
- RLPy.EHikEffector_RightShoulder
- RLPy.EHikEffector_LeftFoot
- RLPy.EHikEffector_LeftKnee
- RLPy.EHikEffector_LeftHip
- RLPy.EHikEffector_RightFoot
- RLPy.EHikEffector_RightKnee
- RLPy.EHikEffector_RightHip
- RLPy.EHikEffector_Hip
- RLPy.EHikEffector_Head
- RLPy.EHikEffector_Neck
- RLPy.EHikEffector_ChestOrigin
- RLPy.EHikEffector_LeftToe
- RLPy.EHikEffector_RightToe
- RLPy.EHikEffector_LeftFingerBase
- RLPy.EHikEffector_RightFingerBase
- RLPy.EHikEffector_Quantity
Returns
True if human IK effector translate status is locked, False if human IK effector translate is unlocked - bool
ProcessEffector
RLPy.RIHikEffectorComponent.ProcessEffector ( self, args )
Process world matrix to human IK effector. ( Experimental API )
Parameters
kWorldMatrix [IN] World matrix - RLPy.RMatrix4f
Return Values
RLPy.RStatus.Success Success
RLPy.RStatus.Failure Fail
SetEffectorLockRotate
RLPy.RIHikEffectorComponent.SetEffectorLockRotate ( self, eEffector, bLock )
Set human IK effector lock rotate status. ( Experimental API )
Parameters
eEffector [IN] Human IK effector - RLPy.EHikEffector
- RLPy.EHikEffector_Invalid
- RLPy.EHikEffector_LeftHand
- RLPy.EHikEffector_LeftElbow
- RLPy.EHikEffector_LeftShoulder
- RLPy.EHikEffector_RightHand
- RLPy.EHikEffector_RightElbow
- RLPy.EHikEffector_RightShoulder
- RLPy.EHikEffector_LeftFoot
- RLPy.EHikEffector_LeftKnee
- RLPy.EHikEffector_LeftHip
- RLPy.EHikEffector_RightFoot
- RLPy.EHikEffector_RightKnee
- RLPy.EHikEffector_RightHip
- RLPy.EHikEffector_Hip
- RLPy.EHikEffector_Head
- RLPy.EHikEffector_Neck
- RLPy.EHikEffector_ChestOrigin
- RLPy.EHikEffector_LeftToe
- RLPy.EHikEffector_RightToe
- RLPy.EHikEffector_LeftFingerBase
- RLPy.EHikEffector_RightFingerBase
- RLPy.EHikEffector_Quantity
bLock [IN] Lock rotate status - bool
Return Values
RLPy.RStatus.Success Success
RLPy.RStatus.Failure Fail
SetEffectorLockTranslate
RLPy.RIHikEffectorComponent.SetEffectorLockTranslate ( self, eEffector, bLock )
Set human IK effector lock translate status. ( Experimental API )
Parameters
eEffector [IN] Human IK effector - RLPy.EHikEffector
- RLPy.EHikEffector_Invalid
- RLPy.EHikEffector_LeftHand
- RLPy.EHikEffector_LeftElbow
- RLPy.EHikEffector_LeftShoulder
- RLPy.EHikEffector_RightHand
- RLPy.EHikEffector_RightElbow
- RLPy.EHikEffector_RightShoulder
- RLPy.EHikEffector_LeftFoot
- RLPy.EHikEffector_LeftKnee
- RLPy.EHikEffector_LeftHip
- RLPy.EHikEffector_RightFoot
- RLPy.EHikEffector_RightKnee
- RLPy.EHikEffector_RightHip
- RLPy.EHikEffector_Hip
- RLPy.EHikEffector_Head
- RLPy.EHikEffector_Neck
- RLPy.EHikEffector_ChestOrigin
- RLPy.EHikEffector_LeftToe
- RLPy.EHikEffector_RightToe
- RLPy.EHikEffector_LeftFingerBase
- RLPy.EHikEffector_RightFingerBase
- RLPy.EHikEffector_Quantity
bLock [IN] Lock translate status - bool
Return Values
RLPy.RStatus.Success Success
RLPy.RStatus.Failure Fail
