Class cv::viz::KeyboardEvent#

This class represents a keyboard event.

#include <opencv2/viz/types.hpp>

Collaboration diagram for cv::viz::KeyboardEvent:

cv::viz::KeyboardEvent Node1 cv::viz::KeyboardEvent   + KeyboardEvent() Node2 Action     Node2->Node1 +action Node3 std::string     Node3->Node1 +symbol Node4 std::basic_string< Char >     Node4->Node3 Node5 unsigned     Node5->Node1 +code Node6 int     Node6->Node1 +modifiers

cv::viz::KeyboardEvent Node1 cv::viz::KeyboardEvent   + KeyboardEvent() Node2 Action     Node2->Node1 +action Node3 std::string     Node3->Node1 +symbol Node4 std::basic_string< Char >     Node4->Node3 Node5 unsigned     Node5->Node1 +code Node6 int     Node6->Node1 +modifiers

Public Types#

enum cv::viz::KeyboardEvent {
    cv::viz::NONE = 0,
    cv::viz::ALT = 1,
    cv::viz::CTRL = 2,
    cv::viz::SHIFT = 4
}
enum Action {
    KEY_UP = 0,
    KEY_DOWN = 1
}

Detailed Description#

This class represents a keyboard event.

Member Enumeration Documentation#

enum KeyboardEvent

NONE

ALT

CTRL

SHIFT

enum Action

KEY_UP
Python: cv.viz.KeyboardEvent_KEY_UP

KEY_DOWN
Python: cv.viz.KeyboardEvent_KEY_DOWN

Constructor & Destructor Documentation#

KeyboardEvent()#

cv::viz::KeyboardEvent::KeyboardEvent(
Action action,
const String & symbol,
unsigned char code,
int modifiers )

Constructs a KeyboardEvent.

Parameters

  • action — Signals if key is pressed or released.

  • symbol — Name of the key.

  • code — Code of the key.

  • modifiers — Signals if alt, ctrl or shift are pressed or their combination.

Member Data Documentation#

action#

Action cv::viz::KeyboardEvent::action

code#

unsigned char cv::viz::KeyboardEvent::code

modifiers#

int cv::viz::KeyboardEvent::modifiers

symbol#

String cv::viz::KeyboardEvent::symbol

Source file#

The documentation for this class was generated from the following file: