kOfxInteractActionKeyDown

	#include "ofxCore.h"
	#define kOfxInteractActionKeyDown "OfxInteractActionKeyDown"
Arguments

  • handle handle to an interact instance, cast to an OfxInteractHandle
  • inArgs has the following properties on an image effect plugin,
  • outArgs is redundant and is set to NULL.

Description

This action is issued when a key on the keyboard is depressed.

No openGL calls should be issued by the plug-in during this action.

Preconditions

Postconditions

  • if the instance returns kOfxStatOK , the host should not pass the pen motion to any other interactive object it may own that shares the same focus.

Return Values

  • kOfxStatOK , the action was trapped and the host should not pass the event to other objects it may own
  • kOfxStatReplyDefault , the action was not trapped and the host can deal with it if it wants