IC8 Python API:RLPy RKey

Main article: iC8 Modules.

Last modified: 10/21/2026

Description

This is the base class for keys which stores the time of the keys. Rkey can be inserted into RControl.

Class Methods

RLPy.RKey.__init__(self, args )

The copy constructor of the class. Initialize a new RKey object with the values from another RKey object.

Parameters

kRhs[IN] The source RKey object - RLPy.RKey

1 # No example

RLPy.RKey.Clone(self)

Clone object. Supports cloning, which creates a new instance of a class with the same value as an existing instance.

1 # No example

RLPy.RKey.GetTime(self)

Get Time of the key.

Returns

Time of the key - RLPy.RLTime

1 # No example

RLPy.RKey.GetTransitionType(self)

Get transition type of the key.

Returns

Transition type of the key - RLPy.ETransitionType

• RLPy.ETransitionType_Invalid Invalid value.
• RLPy.ETransitionType_None None.
• RLPy.ETransitionType_Linear Linear.
• RLPy.ETransitionType_Step Step.
• RLPy.ETransitionType_Ease_Out Ease out.
• RLPy.ETransitionType_Ease_In Ease in.
• RLPy.ETransitionType_Ease_Out_In Ease out in.
• RLPy.ETransitionType_Ease_In_Out Ease in out.
• RLPy.ETransitionType_Ease_In_Sine Ease in sine.
• RLPy.ETransitionType_Ease_Out_Sine Ease out sine.
• RLPy.ETransitionType_Ease_In_Out_Sine Ease in out sine.
• RLPy.ETransitionType_Ease_In_Quad Ease in quad.
• RLPy.ETransitionType_Ease_Out_Quad Ease out quad.
• RLPy.ETransitionType_Ease_In_Out_Quad Ease in out quad.
• RLPy.ETransitionType_Ease_In_Cubic Ease in cubic.
• RLPy.ETransitionType_Ease_Out_Cubic Ease in out cubic.
• RLPy.ETransitionType_Ease_In_Out_Cubic Ease in out cubic.
• RLPy.ETransitionType_Ease_In_Quart Ease in quart.
• RLPy.ETransitionType_Ease_Out_Quart Ease out quart.
• RLPy.ETransitionType_Ease_In_Out_Quart Ease in out quart.
• RLPy.ETransitionType_Ease_In_Quint Ease in quint.
• RLPy.ETransitionType_Ease_Out_Quint Ease out quint.
• RLPy.ETransitionType_Ease_In_Out_Quint Ease in out quint.
• RLPy.ETransitionType_Ease_In_Expo Ease in expo.
• RLPy.ETransitionType_Ease_Out_Expo Ease out expo.
• RLPy.ETransitionType_Ease_In_Out_Expo Ease in out expo.
• RLPy.ETransitionType_Ease_In_Circ Ease in circ.
• RLPy.ETransitionType_Ease_Out_Circ Ease out circ.
• RLPy.ETransitionType_Ease_In_Out_Circ Ease in out circ.
• RLPy.ETransitionType_Ease_In_Back Ease in back.
• RLPy.ETransitionType_Ease_Out_Back Ease out back.
• RLPy.ETransitionType_Ease_In_Out_Back Ease in out back.
• RLPy.ETransitionType_Ease_In_Elastic Ease in elastic.
• RLPy.ETransitionType_Ease_Out_Elastic Ease out elastic.
• RLPy.ETransitionType_Ease_In_Out_Elastic Ease in out elastic.
• RLPy.ETransitionType_Ease_In_Bounce Ease in bounce.
• RLPy.ETransitionType_Ease_Out_Bounce Ease out bounce.
• RLPy.ETransitionType_Ease_In_Out_Bounce Ease in out bounce.
• RLPy.ETransitionType_Last Last.
• RLPy.ETransitionType_Count

1 # No example

RLPy.RKey.SetTime(self, kTick )

Set time of the key.

Parameters

kTime[IN] Time of the key.

1 key = RLPy.RTransformKey()
2 key.SetTime(RLPy.RTime(0))

RLPy.RKey.SetTransitionStrength(self, fTransitionStrength )

Set transition strength of the key.

Parameters

fTransitionStrength[IN] Transition strength of the key - float

1 key = RLPy.RTransformKey()
2 key.SetTransitionStrength(90)

RLPy.RKey.SetTransitionType(self, eTransitionType )

Set transition type of the key.

Parameters

eTransitionType[IN] Transition type of the key - RLPy.ETransitionType

• RLPy.ETransitionType_Invalid Invalid value.
• RLPy.ETransitionType_None None.
• RLPy.ETransitionType_Linear Linear.
• RLPy.ETransitionType_Step Step.
• RLPy.ETransitionType_Ease_Out Ease out.
• RLPy.ETransitionType_Ease_In Ease in.
• RLPy.ETransitionType_Ease_Out_In Ease out in.
• RLPy.ETransitionType_Ease_In_Out Ease in out.
• RLPy.ETransitionType_Ease_In_Sine Ease in sine.
• RLPy.ETransitionType_Ease_Out_Sine Ease out sine.
• RLPy.ETransitionType_Ease_In_Out_Sine Ease in out sine.
• RLPy.ETransitionType_Ease_In_Quad Ease in quad.
• RLPy.ETransitionType_Ease_Out_Quad Ease out quad.
• RLPy.ETransitionType_Ease_In_Out_Quad Ease in out quad.
• RLPy.ETransitionType_Ease_In_Cubic Ease in cubic.
• RLPy.ETransitionType_Ease_Out_Cubic Ease in out cubic.
• RLPy.ETransitionType_Ease_In_Out_Cubic Ease in out cubic.
• RLPy.ETransitionType_Ease_In_Quart Ease in quart.
• RLPy.ETransitionType_Ease_Out_Quart Ease out quart.
• RLPy.ETransitionType_Ease_In_Out_Quart Ease in out quart.
• RLPy.ETransitionType_Ease_In_Quint Ease in quint.
• RLPy.ETransitionType_Ease_Out_Quint Ease out quint.
• RLPy.ETransitionType_Ease_In_Out_Quint Ease in out quint.
• RLPy.ETransitionType_Ease_In_Expo Ease in expo.
• RLPy.ETransitionType_Ease_Out_Expo Ease out expo.
• RLPy.ETransitionType_Ease_In_Out_Expo Ease in out expo.
• RLPy.ETransitionType_Ease_In_Circ Ease in circ.
• RLPy.ETransitionType_Ease_Out_Circ Ease out circ.
• RLPy.ETransitionType_Ease_In_Out_Circ Ease in out circ.
• RLPy.ETransitionType_Ease_In_Back Ease in back.
• RLPy.ETransitionType_Ease_Out_Back Ease out back.
• RLPy.ETransitionType_Ease_In_Out_Back Ease in out back.
• RLPy.ETransitionType_Ease_In_Elastic Ease in elastic.
• RLPy.ETransitionType_Ease_Out_Elastic Ease out elastic.
• RLPy.ETransitionType_Ease_In_Out_Elastic Ease in out elastic.
• RLPy.ETransitionType_Ease_In_Bounce Ease in bounce.
• RLPy.ETransitionType_Ease_Out_Bounce Ease out bounce.
• RLPy.ETransitionType_Ease_In_Out_Bounce Ease in out bounce.
• RLPy.ETransitionType_Last Last.
• RLPy.ETransitionType_Count

1 key = RLPy.RTransformKey()
2 key.SetTransitionType(RLPy.ETransitionType_Ease_Out)

Description

Keyframes are used to record transition points in an animation. Keyframe values are called "keys". These keys mainly record time and transition data and are managed by controls which are responsible for changing and deleting key values. This box object's PositionX animation is controlled by [[IC_Python_API:RLPy_RFloatControl|RFloatControl. Thus, this object's timeline transitions are recorded in RFloatKey]] See also: RFloatControl, RTransformControl.

Constructor & Destructor

__init__ (self, *args)

Create a new RKey object using an existing RKey object.

Parameters

• args

Member Functions

Clone (self)

Copy this key's data and return a new RKey object.

GetTime (self)

Get this key's time value.

GetTransitionStrength (self)

Get this key's transition strength. This value lies between 1 and 100 (default: 50). This function will only take effect when the transition type for this key is ETransitionType_EASE_OUT, ETransitionType_EASE_IN, ETransitionType_EASE_OUT_IN or ETransitionType_EASE_IN_OUT. See Also: SetTransitionStrength

GetTransitionType (self)

Get this key's transition type. See Also: SetTransitionType

SetTime (self, kTick)

Set the time value for this key.

Parameters

• kTick

SetTransitionStrength (self, fTransitionStrength)

Set the key's transition strength from 1 to 100 (default: 50). This function will only take effect when the transition type for this key is ETransitionType_EASE_OUT, ETransitionType_EASE_IN, ETransitionType_EASE_OUT_IN or ETransitionType_EASE_IN_OUT. See Also: GetTransitionStrength, RLPy.ETransitionType

Parameters

• fTransitionStrength

SetTransitionType (self, eTransitionType)

Set the key's transition type.

Parameters

• eTransitionType

Properties

thisown

Indicates whether this SWIG proxy owns the underlying C++ object.

{"minExpandLevel":2}

• Python API
• API_Modules
  • Mathematics
    • RMath
    • RVector2
    • RVector3
    • RVector4
    • RMatrix3
    • RQuaternion
    • RTransform
    • RRgb
    • RColor
  • System
    • RStatus
    • RTime
    • RVariant
    • RFileIO
    • RGlobal
    • RPyTimer
    • RApplication
  • Scene
    • RIBase
    • RIObject
    • RINode
    • RIMaterialComponent
    • RIProp
    • RIAvatar
    • RICamera
    • RIParticle
    • RILight
    • RISpotLight
    • RIPointLight
    • RIDirectionalLight
    • RScene
  • Animation
    • RDataBlock
    • RKey
    • RControl
    • RFloatkey
    • RFloatControl
    • RTransformkey
    • RTransformControl
    • RlClip
    • RISkeletonComponent
    • RVisemeSmoothOption
    • RIVisemeComponent
    • RIMorphComponent
    • RIHikEffectorComponent
    • RIFaceComponent
  • MotionCapture
    • RPositionSetting
    • RRotationSetting
    • RDeviceSetting
    • RIDeviceBase
    • RBodySetting
    • RIBodyDevice
    • RHandSetting
    • RIHandDevice
    • RFacialSetting
    • RIFacialDevice
    • RIMocapManager
  • Events
    • RCallback
    • RWinMessageCallback
    • RDialogCallback
    • REventCallback
    • REventHandler
    • RPyTimerCallback
    • RIEventListener
  • UI
    • RIDialog
    • RIDockWidget
    • RUi
  • Media
    • RIAudioObject
    • RAudioRecorder
    • RAudio
    • RAudioRecorderCallback
  • Networking
    • RTcpCallback
    • RTcpClient
    • RUdpCallback
    • RUdpClient