IC Python API:RLPy RINode

From Reallusion Wiki!
Jump to: navigation, search
Main article: Modules.

Detailed Description

This class is the base class of the objects in the scene.

avatar_list = RLPy.RScene.GetAvatars()
avatar = avatar_list[0]

# basic information
print(avatar.GetName())
print(avatar.GetID())
print(avatar.GetType()) # RLPy.EObjectType_Avatar

# get control
transform_control = avatar.GetControl("Transform") # type RTransformControl
avatar_path_position_control = avatar.GetControl("PathPosition") # type RFloatControl
avatar_path_offset_control = avatar.GetControl("PathOffset") # type RTransformControl

Member Functions

GetControl

RLPy.RIObject.GetControl ( self, strKey )

Get control of the object.

Parameters

strKey [IN] Key of the controller, allowing use "Transform" to retrieve the transform control of the Transform track, use "PathPosition" to retrieve the float control of Path position track, and use "PathOffset" to retrieve the transform control of the Path Offset track, - string

Returns

The specified control - RLPy.RControl


GetID

RLPy.RIObject.GetID ( self )

Get unique id of the object.

Returns

Object id - int


GetMeshNames

RLPy.RIObject.GetMeshNames ( self )

Get all mesh names of the object.

Returns

Mesh name list - string


GetName

RLPy.RIObject.GetName ( self )

Get name of the object.

Returns

Object name - string


GetType

RLPy.RIObject.GetType ( self )

Get object type of the object.

Returns

Object type - RLPy.EObjectType

  • RLPy.EObjectType_Object
  • RLPy.EObjectType_Avatar
  • RLPy.EObjectType_Prop
  • RLPy.EObjectType_Camera
  • RLPy.EObjectType_Particle
  • RLPy.EObjectType_Light
  • RLPy.EObjectType_SpotLight
  • RLPy.EObjectType_PointLight
  • RLPy.EObjectType_DirectionalLight

LocalTransform

RLPy.RIObject.LocalTransform ( self )

Get local transform of the object. ( Experimental API )

Returns

Object transform - RLPy.RTransformf


WorldTransform

RLPy.RIObject.WorldTransform ( self )

Get world transform of the object. ( Experimental API )

Returns

Object transform - RLPy.RTransformf