InputFlagsExample.cpp

InputFlags-Example shows how to use widgets InputFlags to modify widgets behaviour.

Screenshot of the InputFlags-example.

Our example consists of multiple widgets which each have a limited set of features. These features are controlled by the Widget::InputFlags that are set individually to each widget.

Here widget's setInputFlags-method is used to enable x-motion in the first widget, y-motion to the second, and both for the third one.

  auto xw = MultiWidgets::create<MultiWidgets::TextWidget>("Just X-motion");
  xw->setInputFlags(MultiWidgets::Widget::INPUT_TRANSLATE_X);
  app.mainLayer()->addChild(xw);

  auto yw = MultiWidgets::create<MultiWidgets::TextWidget>("Just Y-motion");
  yw->setInputFlags(MultiWidgets::Widget::INPUT_TRANSLATE_Y);
  app.mainLayer()->addChild(yw);

  auto xyw = MultiWidgets::create<MultiWidgets::TextWidget>("Just XY-motion");
  xyw->setInputFlags(MultiWidgets::Widget::INPUT_TRANSLATE_XY);
  app.mainLayer()->addChild(xyw);

By using the same method and bitwise OR-operation we can set multiple flags at the same time. Following code allows widget to rotate and move in the x-direction.

  auto xrw = MultiWidgets::create<MultiWidgets::TextWidget>("Just X-motion and Rotation");
  xrw->setInputFlags(MultiWidgets::Widget::INPUT_TRANSLATE_X | MultiWidgets::Widget::INPUT_ROTATION);

If we want to disable some single behaviour (such as scaling) it is more convienient to use clearInputFlags()-method. This leaves the other functionality intact, while disabling the requested behaviour.

  auto nsw = MultiWidgets::create<MultiWidgets::TextWidget>("No Scale");
  nsw->clearInputFlags(MultiWidgets::Widget::INPUT_SCALE);

It is also possible to raise single or multiple flags in case where they have been disabled earlier. This is done by using the raiseInputFlags()-method.

  auto srw = MultiWidgets::create<MultiWidgets::TextWidget>("Scale and Rotation");
  srw->setInputFlags(MultiWidgets::Widget::INPUT_NONE);
  srw->raiseInputFlags(MultiWidgets::Widget::INPUT_ROTATION | MultiWidgets::Widget::INPUT_SCALE);

Besides Widget, also other Cornerstone classes have similar kinds of flags that can be controlled. Here we show class InputGrabber, that can be used to enable / disable some of the grabbing behaviour by specifying a combination of TrackedObjectType flags. In this example we disable grab-events coming from the hands. All other input methods (fingers, pens and markers) are left intact.

  auto fw = MultiWidgets::create<MultiWidgets::TextWidget>("Just Finger grabs");
  fw->inputGrabber().clearGrabFlags(MultiTouch::TYPE_HAND);

The full source code for the example is listed below:

/* Copyright (C) 2007-2013 Multi Touch Oy, Finland, http://www.multitaction.com
 *
 * This file is part of MultiTouch Cornerstone.
 *
 * All rights reserved. You may use this file only for purposes for which you
 * have a specific, written permission from Multi Touch Oy.
 *
 */

#include <MultiWidgets/Application.hpp>
#include <MultiWidgets/TextWidget.hpp>

int main(int argc, char** argv)
{
  MultiWidgets::Application app;

  if(!app.init(argc, argv))
    return 1;

  app.addStyleFilename("input-flags.css");

  auto xw = MultiWidgets::create<MultiWidgets::TextWidget>("Just X-motion");
  xw->setInputFlags(MultiWidgets::Widget::INPUT_TRANSLATE_X);
  app.mainLayer()->addChild(xw);

  auto yw = MultiWidgets::create<MultiWidgets::TextWidget>("Just Y-motion");
  yw->setInputFlags(MultiWidgets::Widget::INPUT_TRANSLATE_Y);
  app.mainLayer()->addChild(yw);

  auto xyw = MultiWidgets::create<MultiWidgets::TextWidget>("Just XY-motion");
  xyw->setInputFlags(MultiWidgets::Widget::INPUT_TRANSLATE_XY);
  app.mainLayer()->addChild(xyw);

  auto xrw = MultiWidgets::create<MultiWidgets::TextWidget>("Just X-motion and Rotation");
  xrw->setInputFlags(MultiWidgets::Widget::INPUT_TRANSLATE_X | MultiWidgets::Widget::INPUT_ROTATION);
  app.mainLayer()->addChild(xrw);

  auto sw = MultiWidgets::create<MultiWidgets::TextWidget>("Just Scale");
  sw->setInputFlags(MultiWidgets::Widget::INPUT_SCALE);
  app.mainLayer()->addChild(sw);

  auto nsw = MultiWidgets::create<MultiWidgets::TextWidget>("No Scale");
  nsw->clearInputFlags(MultiWidgets::Widget::INPUT_SCALE);
  app.mainLayer()->addChild(nsw);

  auto rw = MultiWidgets::create<MultiWidgets::TextWidget>("Just Rotation");
  rw->setInputFlags(MultiWidgets::Widget::INPUT_ROTATION);
  app.mainLayer()->addChild(rw);

  auto srw = MultiWidgets::create<MultiWidgets::TextWidget>("Scale and Rotation");
  srw->setInputFlags(MultiWidgets::Widget::INPUT_NONE);
  srw->raiseInputFlags(MultiWidgets::Widget::INPUT_ROTATION | MultiWidgets::Widget::INPUT_SCALE);
  app.mainLayer()->addChild(srw);

  auto fw = MultiWidgets::create<MultiWidgets::TextWidget>("Just Finger grabs");
  fw->inputGrabber().clearGrabFlags(MultiTouch::TYPE_HAND);
  app.mainLayer()->addChild(fw);

  int x = 200;
  int y = 200;
  int xmax = 850;

  for(auto it = app.mainLayer()->childBegin(); it != app.mainLayer()->childEnd(); ++it) {
    MultiWidgets::WidgetPtr w = *it;
    w->setLocation(x, y);

    x += 150;
    if(x > xmax) {
      x = 200;
      y += 200;
    }
  }

  return app.run();
}