Trait/Object

scalismo.ui.control.interactor

Interactor

Related Docs: object Interactor | package interactor

Permalink

trait Interactor extends AnyRef

Interaction strategy. An interaction strategy gets notified about events before they are passed to the rendering implementation. This can be used for building complicated interaction state machines, as well as to selectively block events from reaching the rendering implementation.

Interactors are made active by using the scalismo.ui.view.ScalismoFrame.interactor setter.

They are invoked from the scalismo.ui.rendering.internal.EventInterceptor class, and if the verdict is to pass on the event, it is handled by an scalismo.ui.rendering.internal.InteractorForwarder, ultimately reaching the scalismo.ui.rendering.internal.RenderWindowInteractor in the rendering implementation.

The above paragraph was to explain how things work, but also to provide quick links for navigating to the relevant classes :-)

The UI comes with a couple of predefined recipes, defined in the Recipe class, as well as traits which combine recipes into fully-usable "behavior bundles". When mixing in these traits, the order may be important. Roughly speaking, traits further to the right take effect first. When you call a method on a class with mixins, the method in the trait furthest to the right is called first. If that method calls super, it invokes the method in the next trait to its left, and so on.

Mixins are useful, but have to be handled with care. Don't overdo it. If in doubt, manually combine recipes instead.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Interactor
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. def keyPressed(e: KeyEvent): Verdict

    Permalink
  13. def keyReleased(e: KeyEvent): Verdict

    Permalink
  14. def keyTyped(e: KeyEvent): Verdict

    Permalink
  15. def mouseClicked(e: MouseEvent): Verdict

    Permalink
  16. def mouseDragged(e: MouseEvent): Verdict

    Permalink
  17. def mouseEntered(e: MouseEvent): Verdict

    Permalink
  18. def mouseExited(e: MouseEvent): Verdict

    Permalink
  19. def mouseMoved(e: MouseEvent): Verdict

    Permalink
  20. def mousePressed(e: MouseEvent): Verdict

    Permalink
  21. def mouseReleased(e: MouseEvent): Verdict

    Permalink
  22. def mouseWheelMoved(e: MouseWheelEvent): Verdict

    Permalink
  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def onActivated(frame: ScalismoFrame): Unit

    Permalink

    This method is invoked when an interactor is activated in a frame.

    This method is invoked when an interactor is activated in a frame.

    It can be used to initialize the interactor state, or to add UI elements (e.g. toolbar buttons) to the frame.

  27. def onDeactivated(frame: ScalismoFrame): Unit

    Permalink

    This method is invoked when an interactor is deactivated, i.e., removed.

    This method is invoked when an interactor is deactivated, i.e., removed.

    It should clean up / revert any changes that the interactor made to the UI.

  28. implicit def pimpEvent[E <: InputEvent](event: E): PimpedEvent[E]

    Permalink
    Attributes
    protected
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped