IC8 Python API:RLPy RReachKey

From Reallusion Wiki!
Jump to: navigation, search
Main article: iC8 Modules.
Last modified: 10/21/2026

Description

Stores reach-key data, including time, target object, key type, force-reach and rotation flags, and transition range. It can also create a copy of the key.

Class Methods

RLPy.RReachKey.GetForceReach(self)

Get Reach Mode: Reach Object of the key.

Returns

flag of Reach Mode: Reach Object - bool 

1 # No example

RLPy.RReachKey.GetKeyType(self)

Get ReachKeyType of the key.

Returns

ReachKeyType of the key - RLPy.ReachKeyType

  • RLPy.Target
  • RLPy.Lock
  • RLPy.Release
1 # No example

RLPy.RReachKey.GetRotationActive(self)

Get Reach Mode: Rotation of the key.

Returns

flag of Reach Mode: Rotation - bool 

1 # No example

RLPy.RReachKey.GetTargetObject(self)

Get TargetObject of the key.

Returns

TargetObject of the key - RLPy.RIObject 

1 # No example

RLPy.RReachKey.GetTime(self)

Get Time of the key.

Returns

Time of the key - RLPy.RLTime 

1 # No example

RLPy.RReachKey.GetTransitionRange(self)

Get TransitionRange of the key.

Returns

TransitionRange of the key - RLPy.RLTime 

1 # No example

RLPy.RReachKey.SetForceReach(self, bPull )

Set Reach Mode: Reach Object of the key.

Parameters

bRotateActive[IN] flag of Reach Mode: Reach Object.
1 # No example

RLPy.RReachKey.SetKeyType(self, eKeyType )

Set ReachKeyType of the key.

Parameters

eKeyType[IN] ReachKeyType of the key - RLPy.ReachKeyType
  • RLPy.Target
  • RLPy.Lock
  • RLPy.Release
1 # No example

RLPy.RReachKey.SetRotationActive(self, bRotateActive )

Set Reach Mode: Rotation of the key.

Parameters

bRotateActive[IN] flag of Reach Mode: Rotation - bool
1 # No example

RLPy.RReachKey.SetTargetObject(self, hTargetObject )

Set TargetObject of the key.

Parameters

hTargetObject[IN] TargetObject of the key - RLPy.RIObject
1 # No example

RLPy.RReachKey.SetTime(self, kTime )

Set time of the key.

Parameters

kTime[IN] Time of the key - RLPy.RLTime
1 # No example

RLPy.RReachKey.SetTransitionRange(self, kForwardTransitionRange )

Set TransitionRange of the key.

Parameters

kForwardTransitionRange[IN] TransitionRange of the key - RLPy.RLTime
1 # No example

Description

Stores reach-key data, including time, target object, key type, force-reach and rotation flags, and transition range. It can also create a copy of the key.

Constructor & Destructor

__init__ (self, *args)

Initializes a new reach key instance.

Parameters

  • args

Member Functions

Clone (self)

Creates and returns a copy of this reach key.

GetForceReach (self)

Gets Reach Mode: Reach Object of the key.

GetKeyType (self)

Gets ReachKeyType of the key.

GetRotationActive (self)

Gets Reach Mode: Rotation of the key.

GetTargetObject (self)

Gets TargetObject of the key.

GetTime (self)

Gets Time of the key.

GetTransitionRange (self)

Gets TransitionRange of the key.

SetForceReach (self, bPull)

Sets Reach Mode: Reach Object of the key.

Parameters

  • bPull

SetKeyType (self, eKeyType)

Sets ReachKeyType of the key.

Parameters

  • eKeyType

SetRotationActive (self, bRotateActive)

Sets Reach Mode: Rotation of the key.

Parameters

  • bRotateActive

SetTargetObject (self, hTargetObject)

Sets TargetObject of the key.

Parameters

  • hTargetObject

SetTime (self, kTime)

Sets time of the key.

Parameters

  • kTime

SetTransitionRange (self, kForwardTransitionRange)

Sets TransitionRange of the key.

Parameters

  • kForwardTransitionRange

Properties

thisown

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

Retrieved from "http://wiki.reallusion.com/index.php?title=IC8_Python_API:RLPy_RReachKey&oldid=6219"