BaseEvent (object)

バージョン 1.12.0 で追加.

BaseEvent is the base class for all Event object types.

BaseEvent BaseEvent BaseEvent Event Event BaseEvent->Event KeyEvent KeyEvent KeyEvent->BaseEvent MouseEvent MouseEvent MouseEvent->BaseEvent MouseWheelEvent MouseWheelEvent MouseWheelEvent->BaseEvent

Members

Host host The Host object providing a method to query data about the host and propagate data back to the host.
Viewport_Virtual viewport The viewport that was in focus when the event was generated.
EventType eventType The id specifying the type of event.
Boolean accepted A boolean flag indicating that the event has been accepted, and no should not be handled by other handlers or the host DCC application.
Boolean redrawAllViewportsIfAccepted A boolean flag indicating if all viewports must be redrawn. If false, only event’s viewport must be redrawn.
ModiferKey modifiers The keyboard modifier keys that were held when the event occurred.
String dfgToolPath Path of the DFG node containing the tool. Uses to propagate the manipulated value throuht ports.

Methods

  BaseEvent ( in BaseEvent other )
  BaseEvent ()
  accept ! ()
BaseEvent clone ? ()
EventType eventType ? ()
Host getHost ? ()
ModiferKey getModifiers ? ()
Viewport_Virtual getViewport ? ()
  ignore ! ()
  init ! ( in Host host, in Viewport_Virtual viewport, in EventType eventType, in ModiferKey modifiers )
Boolean isAccepted ? ()
Boolean redrawAllViewports ? ()
  setAccepted ! ( in Boolean accepted )
  setViewport ! ( in Viewport_Virtual viewport )

Methods in detail

BaseEvent ( in BaseEvent other )

copy constructor


BaseEvent ()

Constructor.


BaseEvent.accept! ()

Implementation of Event.


BaseEvent BaseEvent.clone? ()

clone method


EventType BaseEvent.eventType? ()

Implementation of Event.


Host BaseEvent.getHost? ()

Implementation of Event.


ModiferKey BaseEvent.getModifiers? ()

Implementation of Event.


Viewport_Virtual BaseEvent.getViewport? ()

Implementation of Event.


BaseEvent.ignore! ()

Implementation of Event.


BaseEvent.init! ( in Host host, in Viewport_Virtual viewport, in EventType eventType, in ModiferKey modifiers )

Initializes the base event members.

host The host (‘Maya’, ‘SoftImage’, ...).
viewport The viewport interface.
eventType The event type.
modifiers The key modifier associatede with the event.


Boolean BaseEvent.isAccepted? ()

Implementation of Event.


Boolean BaseEvent.redrawAllViewports? ()

Returns true if all viewports need to be redrawn, and not only the contextual one.


BaseEvent.setAccepted! ( in Boolean accepted )

Implementation of Event.


BaseEvent.setViewport! ( in Viewport_Virtual viewport )

Implementation of Event.