Difference between revisions of "IC Python API:RLPy RILight"

From Reallusion Wiki!
Jump to: navigation, search
m
m (→‎Description)
Line 7: Line 7:
 
'''RILight''' is the base class for all light sources and provides settings for some basic properties, e.g. active states, strength, color values, etc.  It also provides a Transform Control with the ability to set translation, rotation, and scale keys.
 
'''RILight''' is the base class for all light sources and provides settings for some basic properties, e.g. active states, strength, color values, etc.  It also provides a Transform Control with the ability to set translation, rotation, and scale keys.
  
−
:Inheritance: [[IC_Python_API:RLPy_RIBase|RIBase]] > [[IC_Python_API:RLPy_RIObject|RIObject]] > '''RILight'''.
+
=== Inheritance ===
 +
 
 +
[[IC_Python_API:RLPy_RIBase|RIBase]] > [[IC_Python_API:RLPy_RIObject|RIObject]] > '''RILight'''.
  
 
== Member Functions ==
 
== Member Functions ==

Revision as of 00:24, 6 April 2020

Main article: Modules.
Last modified: 04/6/2020

Description

RILight is the base class for all light sources and provides settings for some basic properties, e.g. active states, strength, color values, etc. It also provides a Transform Control with the ability to set translation, rotation, and scale keys.

Inheritance

RIBase > RIObject > RILight.

Member Functions

SetActive ( self, bActive )

Set the active state for the light.

See Also: GetActive

Parameters

bActive [IN] The active state - bool
# Get light object
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Spotlight")

# Set light object active status
light_object.SetActive(True)

GetActive ( self )

Get the active state of the light.

See Also: SetActive

Returns

Whether or not the light is active - bool
# Get light object
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Spotlight")

# Get light object active status
active_status = light_object.GetActive()
print(active_status)

SetMultiplier ( self, kTime, fMultiplier )

Set the light's strength value at a given time.

See Also: GetMultiplier

Parameters

kTime [IN] Time at which to set the light's strength value - RTime
fMultiplier [IN] The strength value - float

Returns

Success - RLPy.RStatus.Success
Failure - RLPy.RStatus.Failure
# Get light object
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Spotlight")

# Set light object multiplier value
result = light_object.SetMultiplier(RLPy.RTime(0), 8.0)

GetMultiplier ( self )

Get the light's current strength.

See Also: SetMultiplier

Returns

The strength of the light - float
# Get light object
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Spotlight")

# Get light object multiplier value
multiplier_value = light_object.GetMultiplier()
print(multiplier_value)

SetColor ( self, kTime, kColor )

Set the light's color at a given time.

See Also: GetColor

Parameters

kTime [IN] Time at which to set the light's color - RTime
kColor [IN] The target color for the light - RRgb

Returns

Success - RLPy.RStatus.Success
Failure - RLPy.RStatus.Failure
# Get light object
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Spotlight")

# Set light object color value
result = light_object.SetColor(RLPy.RTime(0), RLPy.RRgb.RED)

GetColor ( self )

Get the light's color at a given time.

See Also: SetColor

Returns

The light's color in RRgb - RRgb
# Get light object
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Spotlight")

# Set light object color value
light_color = light_object.GetColor()
print(light_color)
Retrieved from "http://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RILight&oldid=4430"