IC8 Python API:RLPy RIOmniConnectorManager

From Reallusion Wiki!
Jump to: navigation, search

Description

This class manages Omniverse Live Sync settings and file-transfer operations.

Constructor & Destructor

__init__ (self, *args, **kwargs)

Initializes a new ri omni connector manager instance.

Parameters

  • args
  • kwargs

Member Functions

ObjectSyncStateListChanged (self, kObjects, kSyncStatuses)

Notice that live link list has change, include objects and link state.

Parameters

  • kObjects
  • kSyncStatuses

SetActive2WaySync (self, bActive)

Sets active 2 way live sync, it will receive change from ov to ic.

Parameters

  • bActive

SetActiveLiveAdd (self, bSyncing)

Sets active live add in OV live syncing. Only support camera, light, prop .

Parameters

  • bSyncing

SetObjectSyncState (self, object, bSyncing)

Sets object is syncing. If true, will live sync with omniverse.

Parameters

  • object
  • bSyncing

SetTransferFileMotionSetting (self, kFps, nStartFrame, nEndFrame)

Sets time range, fps for transfer object motion.

Parameters

  • kFps
  • nStartFrame
  • nEndFrame

SetTransferFileSetting (self, nMaxImageSize, nTextureFormat, bDeleteHiddenMesh, bSubdivisionMesh, bPathTracedMaterial, bIbl, bSwitchCamera)

Sets mesh, material transfer parameter.

Parameters

  • nMaxImageSize
  • nTextureFormat
  • bDeleteHiddenMesh
  • bSubdivisionMesh
  • bPathTracedMaterial
  • bIbl
  • bSwitchCamera

SetTransferMotionOnly (self, bMotionOnly)

Sets it only transfer motion when transferFile called.

Parameters

  • bMotionOnly

TransferFile (self, kObjects, kObjectSyncStates)

It will transfer specific objects to target usd file(Omniverse). It only valid if live sync is turn on.

Parameters

  • kObjects
  • kObjectSyncStates

TurnOffLiveSync (self)

Stop all objects live sync with target usd file.

TurnOnLiveSync (self, kObjects)

Start live sync with all object. It will find target usd file and try to sync objects in scene to usd file.

Parameters

  • kObjects

Properties

thisown

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