IC8 Python API:RLPy RIPointLight
Contents
- 1 Description
- 2 Class Methods
- 2.1 RLPy.RIPointLight.ClearRectTexture(self)
- 2.2 RLPy.RIPointLight.GetInverseSquare(self)
- 2.3 RLPy.RIPointLight.GetRange(self)
- 2.4 RLPy.RIPointLight.GetRectWidthHeight(self)
- 2.5 RLPy.RIPointLight.GetTubeLength(self)
- 2.6 RLPy.RIPointLight.GetTubeRadius(self)
- 2.7 RLPy.RIPointLight.GetTubeSoftRadius(self)
- 2.8 RLPy.RIPointLight.IsCastShadow(self)
- 2.9 RLPy.RIPointLight.IsRectangleShape(self)
- 2.10 RLPy.RIPointLight.IsTubeShape(self)
- 2.11 RLPy.RIPointLight.LoadIes(self, strIesFilePath)
- 2.12 RLPy.RIPointLight.LoadRectTexture(self, strTexturePath)
- 2.13 RLPy.RIPointLight.SaveIes(self, strIesFilePath)
- 2.14 RLPy.RIPointLight.SaveRectTexture(self, strTexturePath)
- 2.15 RLPy.RIPointLight.SetCastShadow(self, bEnable)
- 2.16 RLPy.RIPointLight.SetInverseSquare(self, b)
- 2.17 RLPy.RIPointLight.SetRange(self, kTime, fRange)
- 2.18 RLPy.RIPointLight.SetRectangleShape(self, bRectangle)
- 2.19 RLPy.RIPointLight.SetRectWidthHeight(self, vWidthHeight)
- 2.20 RLPy.RIPointLight.SetTubeLength(self, fLength)
- 2.21 RLPy.RIPointLight.SetTubeRadius(self, radius)
- 2.22 RLPy.RIPointLight.SetTubeShape(self, bTube)
- 2.23 RLPy.RIPointLight.SetTubeSoftRadius(self, softRadius)
- Main article: iC8 Modules.
- Last modified: 01/5/2023
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.
Class Methods
RLPy.RIPointLight.ClearRectTexture(self)
Clear rectangle texture of this light.
Experimental API
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.GetInverseSquare(self)
Get if light's intensity follows inverse-square law in physics.
Experimental API
Returns
True if light's intensity follows inverse-square law, False if it is not - bool
1 # No example
RLPy.RIPointLight.GetRange(self)
Get the light range.
Experimental API
Returns
The value of the "range" attribute of the light node - float
1 # use light name to find object
2 light_object = RLPy.RScene.FindObject(RLPy.EObjectType_Light, "Point light")
3 #get light range
4 print(light_object.GetRange())
RLPy.RIPointLight.GetRectWidthHeight(self)
Get the light's rectangle's width & height.
Experimental API
Returns
rectangle's width & height - RLPy.RVector2f
Parameters
- kTime[in] The time at which to set the multiplier.
- fMultiplier[in] The Light multiplier value.
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.GetTubeLength(self)
Get the light's tube length.
Experimental API
Returns
light's tube length - float
1 # No example
RLPy.RIPointLight.GetTubeRadius(self)
Get the light's tube Radius.
Experimental API
Returns
light's tube Radius - float
1 # No example
RLPy.RIPointLight.GetTubeSoftRadius(self)
Get the light's tube SoftRadius.
Experimental API
Returns
light's tube SoftRadius - float
1 # No example
RLPy.RIPointLight.IsCastShadow(self)
Get the light if cast shadow enable.
Experimental API
Returns
True if light is cast shadow enable, False if not - bool
1 # No example
RLPy.RIPointLight.IsRectangleShape(self)
Get if light's shape is a rectangle.
Experimental API
Returns
True if light's shape is a rectangle, False if it is not - bool
1 # No example
RLPy.RIPointLight.IsTubeShape(self)
Get if light's shape is a tube, sphere is also considered a tube with zero length.
Experimental API
Returns
True if light's shape is a tube, False if it is not - bool
1 # No example
RLPy.RIPointLight.LoadIes(self, strIesFilePath)
Load an IES file for this light.
Experimental API
Parameters
- strIesFilePath[in] The IES file path you want to load - string
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.LoadRectTexture(self, strTexturePath)
Load a rectangle texture for this light.
Experimental API
Parameters
- strTexturePath[in] The texture path you want to load - string
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SaveIes(self, strIesFilePath)
Save the IES file of this light.
Experimental API
Parameters
- strIesFilePath[in] The IES file path you want to save - string
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SaveRectTexture(self, strTexturePath)
Save the rectangle texture of this light.
Experimental API
Parameters
- strTexturePath[in] The texture path you want to save - string
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SetCastShadow(self, bEnable)
Set the light's cast shadow is enable.
Experimental API
Parameters
- bEnable[in] If light's cast shadow is enable - bool
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SetInverseSquare(self, b)
Set light's intensity to follow inverse-square law in physics.
Experimental API
Parameters
- b[in] If light's intensity follows inverse-square law - bool
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SetRange(self, kTime, fRange)
Set the light range.
Experimental API
Parameters
- kTime[in] The time at which to set the beam - RLPy.RLTime
- fRange[in] The Light range value - float
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
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())
RLPy.RIPointLight.SetRectangleShape(self, bRectangle)
Set the light's shape to rectangle.
Experimental API
Parameters
- bRectangle[in] If light's shape is a rectangle - bool
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SetRectWidthHeight(self, vWidthHeight)
Set the light's rectangle's width & height.
Experimental API
Parameters
- vWidthHeight[in] rectangle's width & height - RLPy.RVector2f
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SetTubeLength(self, fLength)
Set the light's tube length.
Experimental API
Parameters
- fLength[in] tube length - float
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SetTubeRadius(self, radius)
Set the light's tube radius.
Experimental API
Parameters
- radius[in] tube radius - float
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SetTubeShape(self, bTube)
Set the light's shape to tube, sphere is also considered a tube with zero length.
Experimental API
Parameters
- bTube[in] If light's shape is a tube - bool
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
RLPy.RIPointLight.SetTubeSoftRadius(self, softRadius)
Set the light's tube soft radius.
Experimental API
Parameters
- softRadius[in] tube soft radius - float
Returns
- RLPy.RStatus.Success - Succeed
- RLPy.RStatus.Failure - Fail
1 # No example
