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

Revision as of 00:24, 6 April 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.

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.

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.

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.

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.

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.

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)

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

Revision as of 00:24, 6 April 2020

Contents

Description

Member Functions

SetActive ( self, bActive )

Parameters

GetActive ( self )

Returns

SetMultiplier ( self, kTime, fMultiplier )

Parameters

Returns

GetMultiplier ( self )

Returns

SetColor ( self, kTime, kColor )

Parameters

Returns

GetColor ( self )

Returns

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

@@ Line 1: / Line 1: @@
 {{TOC}}
 {{Parent|IC_Python_API:RL_Python_Modules|Modules}}
-==Inheritance==
+{{last_modified}}
-This class inherits public member functions from:
-*[[IC_Python_API:RLPy_RIObject|RLPy.RIObject]]
-*[[IC_Python_API:RLPy_RIBase|RLPy.RIBase]]
-==Detailed Description==
-This class is the interface to lights in the scene.
-It provides methods to access various parts of a light such as
-transformation, color, range etc. All methods of this class are
-implemented by the system. <span style="background:#ffcccc">( Experimental Class )</span> <syntaxhighlight lang="Python">
-light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Spotlight") # use light name to find object
-light_object.SetActive(True)
-print(light_object.GetActive())
-# set light multiplier
-light_object.SetMultiplier(RLPy.RTime(0), 8.0)
-print(light_object.GetMultiplier())
-# set light color
-color = RLPy.RRgb.RED
-light_object.SetColor(RLPy.RTime(0), color)
-light_object.GetColor().R() # is 1.0
-light_object.GetColor().G() # is 0.0
-light_object.GetColor().B() # is 0.0
-# change light transform
-control = light_object.GetControl("Transform")
-transform = RLPy.RTransform.IDENTITY
-transform.T().x = -75.0
-transform.T().y = -150.0
-transform.T().z = 250.0
-time = RLPy.RTime(0)
-control.SetValue(time, transform)
-#clone object
+== Description ==
-clone_light_object = light_object.Clone()
-print( clone_light_object )
+'''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'''.
+== Member Functions ==
+=== SetActive ( self, bActive ) ===
+Set the active state for the light.
+See Also: [[#RLPy.RILight.GetActive( self )|GetActive]]
+==== Parameters ====
+:'''bActive''' [IN] The active state - bool
-#is selected
-RLPy.RScene.SelectObject(light_object)
-print(light_object.IsSelected()) #True
-</syntaxhighlight>
-==Operators==
-This class supports the following operators:
-{| class="wikitable"
-!Member
-!Operation
-!Syntax
-!Description
-!Example
-|-
-! scope="row"|__eq__
-|Equality
-|a == b
-|If the values of two operands are equal, then the condition becomes true.
-|(a == b) is not true.
-|}
-==Member Functions==
-===GetActive===
 <syntaxhighlight lang="Python">
-RLPy.RILight.GetActive ( self )
+# Get light object
+light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Spotlight")
+# Set light object active status
+light_object.SetActive(True)
 </syntaxhighlight>
-Get if light is active.
-<span style="background:#ffcccc">( Experimental API )</span>
+=== GetActive ( self ) ===
-====Returns====
-<div style="margin-left: 2em;">True if light is active, False if light is not active - bool
+Get the active state of the light.
-</div>
------
+See Also: [[#RLPy.RILight.SetActive( self, bActive )|SetActive]]
-===GetColor===
+==== Returns ====
+:Whether or not the light is active - bool
 <syntaxhighlight lang="Python">
-RLPy.RILight.GetColor ( self )
+# 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)
 </syntaxhighlight>
-Get the light's color.
-<span style="background:#ffcccc">( Experimental API )</span>
+=== SetMultiplier ( self, kTime, fMultiplier ) ===
-====Returns====
-<div style="margin-left: 2em;">The value of the "color" attribute of the light node - RLPy.RRgb
+Set the light's strength value at a given time.
-</div>
------
+See Also: [[RLPy.RILight.GetMultiplier( self )|GetMultiplier]]
-===GetMultiplier===
+==== Parameters ====
+:'''kTime''' [IN] Time at which to set the light's strength value - [[IC_Python_API:RLPy_RTime|RTime]]
+:'''fMultiplier''' [IN] The strength value - float
+==== Returns ====
+:Success - RLPy.RStatus.Success
+:Failure - RLPy.RStatus.Failure
 <syntaxhighlight lang="Python">
-RLPy.RILight.GetMultiplier ( self )
+# 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)
 </syntaxhighlight>
-Get the light's multiplier.
-<span style="background:#ffcccc">( Experimental API )</span>
-====Returns====
-<div style="margin-left: 2em;">The value of the "multiplier" attribute of the light node - float
-</div>
------
-===SetActive===
-<syntaxhighlight lang="Python">
-RLPy.RILight.SetActive ( self, bActive )
-</syntaxhighlight>
-Set if light is active.
-<span style="background:#ffcccc">( Experimental API )</span>
-====Parameters====
-<div style="margin-left: 2em;">
-'''bActive''' [in] If light is active - bool
+=== GetMultiplier ( self ) ===
-</div>
-====Return Values====
-<div style="margin-left: 2em;">
-'''RLPy.RStatus.Success''' Success
+Get the light's current strength.
+See Also: [[#RLPy.RILight.SetMultiplier( self, kTime, fMultiplier )|SetMultiplier]]
+==== Returns ====
+:The strength of the light - float
-'''RLPy.RStatus.Failure''' Fail
-</div>
------
-===SetColor===
 <syntaxhighlight lang="Python">
-RLPy.RILight.SetColor ( self, kTime, kColor )
+# 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)
 </syntaxhighlight>
-Set the light's color.
-<span style="background:#ffcccc">( Experimental API )</span>
-====Parameters====
-<div style="margin-left: 2em;">
-'''kTime''' [in] The time at which to set the color - RLPy.RTime
+=== SetColor ( self, kTime, kColor ) ===
-'''kColor''' [in] The Light RGB value - RLPy.RRgb
+Set the light's color at a given time.
-</div>
-====Return Values====
-<div style="margin-left: 2em;">
-'''RLPy.RStatus.Success''' Success
+See Also: [[#RLPy.RILight.GetColor( self )|GetColor]]
+==== Parameters ====
+:'''kTime''' [IN] Time at which to set the light's color - [[IC_Python_API:RLPy_RTime|RTime]]
+:'''kColor''' [IN] The target color for the light - [[IC_Python_API:RLPy_RRgb|RRgb]]
+==== Returns ====
+:Success - RLPy.RStatus.Success
+:Failure - RLPy.RStatus.Failure
-'''RLPy.RStatus.Failure''' Fail
-</div>
------
-===SetMultiplier===
 <syntaxhighlight lang="Python">
-RLPy.RILight.SetMultiplier ( self, kTime, fMultiplier )
+# 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)
 </syntaxhighlight>
-Set the light's multiplier.
-<span style="background:#ffcccc">( Experimental API )</span>
-====Parameters====
-<div style="margin-left: 2em;">
-'''kTime''' [in] The time at which to set the multiplier - RLPy.RTime
+=== GetColor ( self ) ===
-'''fMultiplier''' [in] The Light multiplier value - float
+Get the light's color at a given time.
-</div>
-====Return Values====
-<div style="margin-left: 2em;">
-'''RLPy.RStatus.Success''' Success
+See Also: [[#RLPy.RILight.SetColor( self, kTime, kColor )|SetColor]]
-'''RLPy.RStatus.Failure''' Fail
+==== Returns ====
-</div>
+:The light's color in '''RRgb''' - [[IC_Python_API:RLPy_RRgb|RRgb]]
-==Inherited By==
-This class is inherited by the following classes:
+<syntaxhighlight lang="Python">
-{| class="wikitable"
+# Get light object
-!Class
+light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Spotlight")
-!Description
-|-
+# Set light object color value
-| [[ IC_Python_API:RLPy_RIDirectionalLight | DirectionalLight ]] || The interface to directional light in the scene.
+light_color = light_object.GetColor()
-|-
+print(light_color)
-| [[ IC_Python_API:RLPy_RIPointLight | PointLight ]] || The interface to point light in the scene.
+</syntaxhighlight>
-|-
-| [[ IC_Python_API:RLPy_RISpotLight | SpotLight ]] || The interface to spot light in the scene.
-|}