IC8 Python API:RLPy RIVisualSettingComponent

From Reallusion Wiki!
Jump to: navigation, search
Main article: iC8 Modules.
Last modified: 10/21/2026

Description

Provides controls for ambient color and image-based lighting (IBL), including IBL enablement, image loading and saving, and synchronization with the sky image and orientation.

Class Methods

RLPy.RIVisualSettingComponent.IsIBLEnable(self)

Get the status of the IBL effect.

Returns

Active or not - bool 

1 # No example

RLPy.RIVisualSettingComponent.IsIBLSyncSkyImage(self)

Get the status of the Sync Sky Image in IBL.

Experimental API

Returns

Enable or not - bool 

1 # No example

RLPy.RIVisualSettingComponent.IsIBLSyncSkyOrientation(self)

Get the status of the Sync Sky Orientation in IBL.

Experimental API

Returns

Enable or not - bool 

1 # No example

RLPy.RIVisualSettingComponent.LoadIBLImage(self, strFilePath )

Load the Image for IBL.

Experimental API

Parameters

strFilePath[IN] Enable or disable two sided material - string

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

RLPy.RIVisualSettingComponent.SetIBLEnable(self, bEnable )

Active or deactive the IBL effect.

Parameters

bEnable[IN] Active or not - bool

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

RLPy.RIVisualSettingComponent.SetIBLSyncSkyImage(self, bEnable )

Enable the status of the Sync Sky Image in IBL.

Experimental API

Parameters

bEnable[IN] Enable or not - bool

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

RLPy.RIVisualSettingComponent.SetIBLSyncSkyOrientation(self, bEnable )

Enable the status of the Sync Sky Orientation in IBL.

Experimental API

Parameters

bEnable[IN] Enable or not - bool

Returns

RLPy.RStatus.Success - Succeed
RLPy.RStatus.Failure - Fail
1 # No example

Description

Provides controls for ambient color and image-based lighting (IBL), including IBL enablement, image loading and saving, and synchronization with the sky image and orientation.

Constructor & Destructor

__init__ (self, *args, **kwargs)

Initializes a new ri visual setting component instance.

Parameters

  • args
  • kwargs

Member Functions

GetAmbientColor (self)

Gets ambient color.

IsIBLEnable (self)

Gets the status of the IBL effect.

IsIBLSyncSkyImage (self)

Gets the status of the Sync Sky Image in IBL.

IsIBLSyncSkyOrientation (self)

Gets the status of the Sync Sky Orientation in IBL.

LoadIBLImage (self, strFilePath)

Loads the Image for IBL.

Parameters

  • strFilePath

SaveIBLImage (self, strFilePath)

Saves the image of IBL.

Parameters

  • strFilePath

SetAmbientColor (self, kColor)

Sets ambient color.

Parameters

  • kColor

SetIBLEnable (self, bEnable)

Active or deactive the IBL effect.

Parameters

  • bEnable

SetIBLSyncSkyImage (self, bEnable)

Enable the status of the Sync Sky Image in IBL.

Parameters

  • bEnable

SetIBLSyncSkyOrientation (self, bEnable)

Enable the status of the Sync Sky Orientation in IBL.

Parameters

  • bEnable

Properties

thisown

Indicates whether this SWIG proxy owns the underlying C++ object.

Retrieved from "http://wiki.reallusion.com/index.php?title=IC8_Python_API:RLPy_RIVisualSettingComponent&oldid=6198"