RLPy.RIProp
+ Inheritance diagram for RLPy.RIProp:

Public Member Functions

def __init__ (self, args, kwargs)
 
def SetVisible (self, kTime, bVisible)
 ( Experimental Function ) Set visible status More...
 
def GetSkeletonComponent (self)
 Get bone root of the object. More...
 
def GetMorphComponent (self)
 Get morph component of the object. More...
 
def GetMaterialComponent (self)
 Get material component of the object. More...
 
- Public Member Functions inherited from RLPy.RIObject
def __init__ (self, args, kwargs)
 
def GetName (self)
 Get name of the object. More...
 
def GetID (self)
 Get unique id of the object. More...
 
def GetControl (self, strKey)
 Get control of the object. More...
 
def GetType (self)
 Get object type of the object. More...
 
def GetMeshNames (self)
 Get all mesh names of the object. More...
 
def __eq__ (self, kRhs)
 
def LocalTransform (self)
 Get local transform of the object. More...
 
def WorldTransform (self)
 Get world transform of the object. More...
 
- Public Member Functions inherited from RLPy.RIBase
def __init__ (self, args, kwargs)
 
def IsValid (self)
 Is valid or not. More...
 

Detailed Description

This class is the interface to props in the scene.

It provides methods to access various parts of an prop such as its name, transformation, etc. All methods of this class are implemented by the system.

prop = RLPy.RScene.FindObject(RLPy.EObjectType_Prop, "Box")
# get Name
prop_name = prop.GetName()
print(prop_name) # Box
# set Transform key
control = prop.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)
# get component
skeleton = prop.GetSkeletonComponent()
print(skeleton.GetClipCount())
# set visible key
prop.SetVisible(RLPy.RTime(600), False)

Member Function Documentation

§ GetMaterialComponent()

def RLPy.RIProp.GetMaterialComponent (   self)

Get material component of the object.

Returns
Pointer of the RIMaterialComponent object - RLPy.RIMaterialComponent

§ GetMorphComponent()

def RLPy.RIProp.GetMorphComponent (   self)

Get morph component of the object.

Returns
Pointer of the RIMorphComponent object - RLPy.RIMorphComponent

§ GetSkeletonComponent()

def RLPy.RIProp.GetSkeletonComponent (   self)

Get bone root of the object.

Returns
bone root - RLPy.RISkeletonComponent

§ SetVisible()

def RLPy.RIProp.SetVisible (   self,
  kTime,
  bVisible 
)

( Experimental Function ) Set visible status

Parameters
kTime[IN] Specifies the time to set visible - RLPy.RTime
bVisible[IN] Visible status - bool
Return values
RLPy.RStatus.SuccessSuccess
RLPy.RStatus.FailureFail