com.ur.urcap.api.domain.userinteraction

Interface UserInteraction

@ProviderType
public interface UserInteraction

This interface provides functionality for requesting input or actions from end users

Since:

1.2.56

Method Summary

Modifier and Type	Method and Description
InputValidationFactory	getInputValidationFactory() This method provides a factory for creating standard input validators that can be used for configuring the virtual keyboard.
KeyboardInputFactory	getKeyboardInputFactory() This method provides a factory for creating keyboard inputs which are used to configure a virtual keyboard/keypad and to request it to be displayed for a Swing GUI component.
RobotMovement	getRobotMovement()
void	getUserDefinedRobotPosition(RobotPositionCallback callback) Deprecated. Use getUserDefinedRobotPosition(RobotPositionCallback2) instead.
void	getUserDefinedRobotPosition(RobotPositionCallback2 callback) Request the end user to use the robot to define a robot position.

Method Detail

getUserDefinedRobotPosition

void getUserDefinedRobotPosition(RobotPositionCallback2 callback)

Request the end user to use the robot to define a robot position. Override the RobotPositionCallback2.onOk(PositionParameters) method to execute code once the end user is done. Optionally override the RobotPositionCallback2.onCancel() method to execute code if the end user cancels the operation.

This method is asynchronous, i.e. the method will return immediately. Only when the end user is done, either RobotPositionCallback2.onOk(PositionParameters) or RobotPositionCallback2.onCancel() will be called.

NOTE: This functionality should not be used in a toolbar contribution (see SwingToolbarService).

Parameters:

callback - the instance callbacks will be made to.

Since:

1.10.0

getUserDefinedRobotPosition

@Deprecated
void getUserDefinedRobotPosition(RobotPositionCallback callback)

Deprecated. Use getUserDefinedRobotPosition(RobotPositionCallback2) instead.

Request the end user to use the robot to define a robot position. Override the RobotPositionCallback.onOk(Pose, JointPositions) method to execute code once the end user is done. Optionally override the RobotPositionCallback.onCancel() method to execute code if the end user cancels the operation.

This method is asynchronous, i.e. the method will return immediately. Only when the end user is done, either RobotPositionCallback.onOk(Pose, JointPositions) or RobotPositionCallback.onCancel() will be called.

NOTE: This functionality should not be used in a toolbar contribution (see SwingToolbarService).

Parameters:

callback - the instance callbacks will be made to.

getRobotMovement

RobotMovement getRobotMovement()

Returns:

an interface providing means of requesting the end user to move the robot.

Since:

1.5.0

getKeyboardInputFactory

KeyboardInputFactory getKeyboardInputFactory()

This method provides a factory for creating keyboard inputs which are used to configure a virtual keyboard/keypad and to request it to be displayed for a Swing GUI component.

NOTE: This functionality is only relevant for URCap nodes with a Swing-based user interface (see SwingProgramNodeService, SwingInstallationNodeService and SwingToolbarService).

Returns:

factory providing access to keyboard inputs.

Since:

1.3.0

getInputValidationFactory

InputValidationFactory getInputValidationFactory()

This method provides a factory for creating standard input validators that can be used for configuring the virtual keyboard. The validators are used to validate the input entered by the user.

NOTE: This functionality is only relevant for URCap nodes with a Swing-based user interface (see SwingProgramNodeService, SwingInstallationNodeService and SwingToolbarService).

Returns:

factory providing access to a set of standard input validators.

Since:

1.3.0