Difference between revisions of "IC Python API:RLPy RIPointLight"
From Reallusion Wiki!
Chuck (RL) (Talk | contribs) m |
Chuck (RL) (Talk | contribs) m |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
== Description == | == Description == | ||
| − | This class provides operations specific to Point Lights. Besides the inherited member functions from [[IC_Python_API:RLPy_RILight|RILight]], | + | This class provides operations specific to Point Lights. Besides the inherited member functions from [[IC_Python_API:RLPy_RILight|RILight]], the point light's range value can also be adjusted. |
=== Inheritance === | === Inheritance === | ||
| − | + | [[IC_Python_API:RLPy_RIBase|RIBase]] > [[IC_Python_API:RLPy_RIObject|RIObject]] > [[IC_Python_API:RLPy_RILight|RILight]] > [[IC_Python_API:RLPy_RIPointLight|RIPointLight]] | |
| − | <syntaxhighlight lang=" | + | === Examples === |
| + | |||
| + | <syntaxhighlight lang="python" line='line'> | ||
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light") # use light name to find object | light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light") # use light name to find object | ||
| Line 52: | Line 54: | ||
:The value of the "range" attribute of the light node - float | :The value of the "range" attribute of the light node - float | ||
| − | <syntaxhighlight lang=" | + | <syntaxhighlight lang="python" line='line'> |
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light") # use light name to find object | light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light") # use light name to find object | ||
| Line 66: | Line 68: | ||
==== Parameters ==== | ==== Parameters ==== | ||
| − | :kTime [ | + | :'''kTime''' [IN] The time at which to set the beam - [[IC_Python_API:RLPy_RTime|RTime]] |
| − | :fRange [ | + | :'''fRange''' [IN] The Light range value - float |
==== Returns ==== | ==== Returns ==== | ||
| Line 73: | Line 75: | ||
:Failure - RLPy.RStatus.Failure | :Failure - RLPy.RStatus.Failure | ||
| − | <syntaxhighlight lang=" | + | <syntaxhighlight lang="python" line='line'> |
light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light") # use light name to find object | light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light") # use light name to find object | ||
Latest revision as of 23:45, 14 April 2020
- Main article: Modules.
- Last modified: 04/14/2020
Description
This class provides operations specific to Point Lights. Besides the inherited member functions from RILight, the point light's range value can also be adjusted.
Inheritance
RIBase > RIObject > RILight > RIPointLight
Examples
1 light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light") # use light name to find object
2
3 # set Parent
4 result = light_object.SetParent(prop2)
5 result = light_object.SetParent(None) #detach from parent
6 # link to & unlink
7 result = light_object.LinkTo(prop2, RLPy.RTime(0))
8 result = light_object.UnLink(RLPy.RTime(0))
9 # set name
10 light_object.SetName( "new_name" )
11 #get bound
12 ret_max = RLPy.RVector3()
13 ret_center = RLPy.RVector3()
14 ret_min = RLPy.RVector3()
15 ret = light_object.GetBounds( ret_max, ret_center, ret_min )
16 print(ret)
17 #get pivot
18 ret_pos = RLPy.RVector3()
19 ret_rot = RLPy.RVector3()
20 light_object.GetPivot( ret_pos, ret_rot )
21 print(ret)
22 #clone object
23 clone_light_object = light_object.Clone()
24 print( clone_light_object )
25 #is selected
26 RLPy.RScene.SelectObject(light_object)
27 print(light_object.IsSelected()) #True
Member Functions
GetRange ( self )
Get the point light range.
See Also: SetRange
Returns
- The value of the "range" attribute of the light node - float
1 light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light") # use light name to find object
2
3 #get light range
4 print(light_object.GetRange())
SetRange ( self, kTime, fRange )
Set the point light range.
See Also: GetRange
Parameters
- kTime [IN] The time at which to set the beam - RTime
- fRange [IN] The Light range value - float
Returns
- Success - RLPy.RStatus.Success
- Failure - RLPy.RStatus.Failure
1 light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light") # use light name to find object
2
3 #set light range
4 light_object.SetRange(RLPy.RTime(0), 1000.0)
5 print(light_object.GetRange())
