Command

class omni.kit.commands.Command

Bases: ABC

Base class for all Commands.

Methods

do()
modify_callback_info(cb_type, args)	Returns a dictionary of information to be passed to callbacks of the given type.

__init__()

modify_callback_info(cb_type: str, args: Dict[str, Any]) → Dict[str, Any]

Returns a dictionary of information to be passed to callbacks of the given type.

By default callbacks are passed a copy of the arguments which were passed to execute() when the command was invoked. This method can be overridden to modify that information for specific callback types.

Parameters

• cb_type – Type of callback the information will be passed to.

• args – A dictionary containing a copy of the arguments with which the command was invoked. This is a shallow copy so implementations may add, remove or replace dictionary elements but should not modify any of the objects contained within it.

Returns

A dictionary of information to be passed to callbacks of the specified type.