IC Python API:RLPy RIDirectionalLight
From Reallusion Wiki!
Revision as of 00:02, 15 April 2020 by Chuck (RL) (Talk | contribs)
Contents
- Main article: Modules.
- Last modified: 04/15/2020
Description
This class provides operations for Directional Lights, e.g. whether or not to cast shadows, the light's color, light strength, etc. You must first retrieve a directional light from the scene in order to use these operations.
Inheritance
RIBase > RIObject > RILight > RIDirectionalLight
Member Functions
SetCastShadow ( self, bEnable )
Turn on or off the directional light's cast shadow.
1 light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Dir. Light")
2
3 if light_object:
4 light_object.SetCastShadow(True)
5 light_object.SetCastShadow(False)
Parameters
- bEnable [IN] Enable or disable cast shadows for the light - bool
Returns
- Success - RLPy.RStatus.Success
- Failure - RLPy.RStatus.Failure
IsCastShadow ( self )
Check whether or not the light is casting shadows.
1 light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Dir. Light")
2
3 if light_object:
4 light_object.SetCastShadow(True)
5 print(light_object.IsCastShadow())
6
7 light_object.SetCastShadow(False)
8 print(light_object.IsCastShadow())
Returns
- True if the light is casting shadows, else False - bool
SetDarkenShadowStrength ( self, kTime, fStrength )
Set the directional light's shadow strength at a given point in time (0 to 100).
1 light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Dir. Light")
2
3 if light_object:
4 result = light_object.SetDarkenShadowStrength(RLPy.RGlobal.GetTime(), 50)
5 print(result)
Parameters
- fStrength [IN] The Light shadow strength value - float
Returns
- Success - RLPy.RStatus.Success
- Failure - RLPy.RStatus.Failure
GetDarkenShadowStrength ( self )
Get the directional light's shadow strength at a given point in time (0 to 100).
Returns
- The light's shadow strength value - float
1 light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Dir. Light")
2
3 if light_object:
4 result = light_object.SetDarkenShadowStrength(RLPy.RGlobal.GetTime(), 50)
5 print(light_object.GetDarkenShadowStrength())
