Switchboard设置参考

Switchboard插件设置

按照下面的步骤修改插件的设置。

1. 在 虚幻编辑器 的主菜单中，选择 编辑（Edit） > 项目设置（Project Settings） 可以打开 项目设置（Project Settings） 窗口。
2. 在 项目设置（Project Settings） 窗口中，在 插件（Plugins） 部分中选择 Switchboard。

Switchboard设置

• 对所有设备插件通用的设置位于 设置（Settings） 面板顶部，包括在初始项目设置期间添加的值。
• 在你添加设备之后，这些设备的设置将附加到设置面板。
• 部分一般设置在设备的设置中是重复的，因此必要时可以覆盖各个设备的值。
• 如果要在特定的设备中覆盖设置，将显示不同的背景颜色。只要覆盖位置正确，更改全局设置就不会导致设备中的此设置发生更改。

下面的部分介绍了所有可以在“设置”面板中修改的设置。

项目设置

多用户服务器设置

虚幻设备设置

KiPro设备设置

Live Link Face

nDisplay设备设置

对于每个nDisplay场景节点：

Shogun设备设置

SoundDevices设备设置

为Switchboard创建你自己的设备插件

根据你的项目需求和你使用的设备，可能需要在Switchboard中添加或扩展设备功能。此部分介绍如何在Python中创建你自己的设备插件。利用一些C++知识即可将Listener扩展成接受更多类型的消息，但本文不包含这方面的内容。

以下说明逐步介绍如何为Switchboard创建新的设备插件 SampleDevice，该插件可用作起点。

1. 要使设备插件在加载后可以在Switchboard中发现，必须在 \Engine\Plugins\VirtualProduction\Switchboard\Source\Switchboard\switchboard\devices\ 中按照命名惯例 <plugin_name>\plugin_<plugin_name>.py 创建一个文件夹和Python文件。
   • 对于 SampleDevice 插件，请创建以下文件：\Engine\Plugins\VirtualProduction\Switchboard\Source\Switchboard\switchboard\devices\sampledevice\plugin_sampledevice.py.
2. 在 plugin_sampledevice.py 文件中，扩展 \Engine\Plugins\VirtualProduction\Switchboard\Source\Switchboard\switchboard\devices\device_base.py 中定义的 Device 类。
   • 从 device_base.py 中导入 Device。
   • 创建新类 DeviceSampleDevice，此类继承自 Device。

   • 从 switchboard/switchboard_logging.py 导入 LOGGER 以报告错误。

     从switchboard.devices.device_base导入Device 从switchboard.switchboard_logging导入LOGGER

     class DeviceSampleDevice(Device):` def init(self, name, ip_address, kwargs): super().__init__(name, ip_address, kwargs)

   确认文件可以被Switchboard发现。启动Switchboard并展开 添加设备（Add Device） 下拉菜单。SampleDevice 出现在列表中。

   
3. 将SampleDevice添加到你的Switchboard不会在视图中创建控件。要创建SampleDevice控件，请扩展 plugin_sampledevice.py 中的 DeviceWidget：
   • 从 device_widget_base.py 导入 DeviceWidget。

   • 创建新类 DeviceWidgetSampleDevice，此类继承自 DeviceWidget。

     从switchboard.devices.device_base导入Device 从switchboard.devices.device_widget_base导入DeviceWidget 从switchboard.switchboard_logging导入LOGGER

     class DeviceSampleDevice(Device): def init(self, name, ip_address, kwargs): super().__init__(name, ip_address, kwargs)

     class DeviceWidgetSampleDevice(DeviceWidget): def init(self, name, device_hash, ip_address, icons, parent=None): super().init(name, device_hash, ip_address, icons, parent=parent)

   确认控件显示在Switchboard中。启动Switchboard并添加一个SampleDevice。一个最小化的SampleDevice控件将显示在视图中。

   
4. 在添加新的SampleDevice时创建自定义对话框，方法是创建继承自 AddDeviceDialog 的新类，并将其分配到 DeviceSampleDevice 类中的静态变量 add_device_dialog。
   • 从 device_widget_base.py 导入 AddDeviceDialog。
   • 从PySide2导入Qt模块
   • 创建继承自 AddDeviceDialog 的新类 AddSampleDeviceDialog，并在调用基础类的构造函数时，将device_type参数设置成“SampleDevice”。
   • 在新类的构造函数中，将QLineEdit文本框添加到对话框。

   • 使用新类覆盖 DeviceSampleDevice 中的 add_device_dialog 静态变量。

     从switchboard.devices.device_base导入Device 从switchboard.devices.device_widget_base导入AddDeviceDialog、DeviceWidget 从switchboard.switchboard_logging导入LOGGER

     从PySide2导入QtWidgets、QtGui、QtCore

     class AddSampleDeviceDialog(AddDeviceDialog): def init(self, existing_devices, parent=None): super().init(device_type="SampleDevice", existing_devices=existing_devices, parent=parent)

     # 创建QTWidgets以添加到表单 self.additional_text_field = QtWidgets.QLineEdit(self)

     # 将新选项附加到父类中定义的QTWidgets.QFormLayout对象 self.form_layout.addRow("Additional Text", self.additional_text_field)

     class DeviceSampleDevice(Device): # 重载与设备插件关联的添加设备对话框对象 add_device_dialog = AddSampleDeviceDialog

     def init(self, name, ip_address, kwargs): super().__init__(name, ip_address, kwargs)

     class DeviceWidgetSampleDevice(DeviceWidget): def init(self, name, device_hash, ip_address, icons, parent=None): super().init(name, device_hash, ip_address, icons, parent=parent) `

   确认新的设备对话框显示在Switchboard中。启动Switchboard并添加一个SampleDevice。额外的文本字段将显示在对话框中。

   
5. Switchboard的右侧还可能有设备的控件，该控件包含其他选项卡式的扩展对话框，可以共享更多信息。要创建此选项卡，需要覆盖 Device 基础类中的类方法 plug_into_ui。
   • 创建新类 SampleDeviceTabView ，此类继承自 QtWidgets.QWidget。
   • 在 DeviceSampleDevice 中创建类成员 tab_view 以容纳控件的实例。

   • 覆盖 DeviceSampleDevice 中的类方法 plug_into_ui，并使用新类 SampleDeviceTabView 初始化 tab_view。

     从switchboard.devices.device_base导入Device 从switchboard.devices.device_widget_base导入AddDeviceDialog、DeviceWidget 从switchboard.switchboard_logging导入LOGGER

     从PySide2导入QtWidgets、QtGui、QtCore

     class AddSampleDeviceDialog(AddDeviceDialog): def init(self, existing_devices, parent=None): super().init(device_type="SampleDevice", existing_devices=existing_devices, parent=parent)

     # 创建QTWidgets以添加到表单 self.additional_text_field = QtWidgets.QLineEdit(self)

     # 将新选项附加到父类中定义的QTWidgets.QFormLayout self.form_layout对象 self.form_layout.addRow("Additional Text", self.additional_text_field)

     class DeviceSampleDevice(Device): add_device_dialog = AddSampleDeviceDialog # 覆盖插件的默认对话框 tab_view = None

     def init(self, name, ip_address, kwargs): super().__init__(name, ip_address, kwargs)

     @classmethod def plug_into_ui(cls, menubar, tabs): ''' Implementation of base class function that allows plugin to inject UI elements. '''

     if not cls.tab_view: cls.tab_view = SampleDeviceTabView(parent=tabs)

     tabs.addTab(cls.tab_view, 'SampleDevice Tab')

     class DeviceWidgetSampleDevice(DeviceWidget): def init(self, name, device_hash, ip_address, icons, parent=None): super().init(name, device_hash, ip_address, icons, parent=parent)

     class SampleDeviceTabView(QtWidgets.QWidget): def init(self, parent): QtWidgets.QWidget.init(self, parent)

   

上述步骤展示了如何为Switchboard创建新设备插件。如需高级示例，请参见Switchboard的nDisplay设备插件。