Difference between revisions of "IC Python API:RLPy RIDirectionalLight"
From Reallusion Wiki!
Chuck (RL) (Talk | contribs) m |
Chuck (RL) (Talk | contribs) m |
||
| Line 9: | Line 9: | ||
=== Inheritance === | === Inheritance === | ||
| − | + | [[IC_Python_API:RLPy_RIBase|RIBase]] > [[IC_Python_API:RLPy_RIObject|RIObject]] > [[IC_Python_API:RLPy_RILight|RILight]] > RIDirectionalLight | |
== Member Functions == | == Member Functions == | ||
| Line 66: | Line 66: | ||
==== Returns ==== | ==== Returns ==== | ||
| − | :RLPy.RStatus. | + | :Success - RLPy.RStatus.Success |
| − | :RLPy.RStatus.Failure | + | :Failure - RLPy.RStatus.Failure |
=== GetDarkenShadowStrength ( self ) === | === GetDarkenShadowStrength ( self ) === | ||
Revision as of 01:10, 9 April 2020
Contents
- Main article: Modules.
- Last modified: 04/9/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.
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Dir. Light")
if light_object:
light_object.SetCastShadow(True)
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.
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Dir. Light")
if light_object:
light_object.SetCastShadow(True)
print(light_object.IsCastShadow())
light_object.SetCastShadow(False)
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).
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Dir. Light")
if light_object:
result = light_object.SetDarkenShadowStrength(RLPy.RGlobal.GetTime(), 50)
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
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Dir. Light")
if light_object:
result = light_object.SetDarkenShadowStrength(RLPy.RGlobal.GetTime(), 50)
print(light_object.GetDarkenShadowStrength())
