Implementation of a custom device interaction

This example shows how a custom device interaction can be implemented. First, it is necessary to create an object for the custom interaction using the device service.

self.customInteraction = vrDeviceService.createInteraction("CustomInteraction")

As the custom interaction should use device actions that are already in use by default interactions (left-trigger-pressed, left-trigger-released), it needs to be added to another interaction group.

self.customInteraction.setSupportedInteractionGroups(["CustomGroup"])

Interaction groups combine different interactions for a certain use case. Within one interaction group each action, like left-trigger-pressed, is only allowed to trigger a single function. This is to prevent unwanted side effects. In this case a new interaction group is used that only contains the custom interaction. The device actions that reflect the button presses on a VR controller need to be created for the device interaction.

self.grabAction = self.customInteraction.createControllerAction("left-trigger-pressed")
self.releaseAction = self.customInteraction.createControllerAction("left-trigger-released")

After that, the newly created device actions can connect their signals to the corresponding methods that should be executed.

self.grabAction.signal().triggered.connect(self.press)
self.releaseAction.signal().triggered.connect(self.release)

It is necessary to activate the interaction group for this interaction.

vrDeviceService.setActiveInteractionGroup("CustomGroup")

The move of a controller is a special signal that is needed by multiple interactions and for this reason it is not handled as a device action. Here, the moved signal is only connected when needed.

device.signal().moved.connect(self.move)

When the interaction is used, it will only print out “press”, “release” and “move” as long as the trigger is pressed.

vr/customInteraction.py

# © 2024 Autodesk, Inc. All rights reserved.

# Define actions as python functions
class MyCustomInteraction:
    def __init__(self):
        # Create new interaction
        self.customInteraction = vrDeviceService.createInteraction("CustomInteraction")
        # Limit the interaction to a new mode to not interfere with other interactions
        self.customInteraction.setSupportedInteractionGroups(["CustomGroup"])

        # Create action objects that a triggered by some input
        self.grabAction = self.customInteraction.createControllerAction("left-trigger-pressed")
        self.releaseAction = self.customInteraction.createControllerAction("left-trigger-released")        

        # Connect these actions to the actual python functions
        self.grabAction.signal().triggered.connect(self.press)
        self.releaseAction.signal().triggered.connect(self.release)        

        # Activate the mode that supports the new interaction
        vrDeviceService.setActiveInteractionGroup("CustomGroup")
    
    def press(self, action, device):
        print("press")
        device.signal().moved.connect(self.move)

    def release(self, action, device):
        print("release")
        device.signal().moved.disconnect(self.move)

    def move(self, device):
        print("move")

myCustomInteraction = MyCustomInteraction()