Event Wrapper¶

group FnEventWrapper

class FnEventWrapper¶

#include <FnEventWrapper.h>

A Wrapper for UI events.

The event is used to pass UI event data from the viewport widget in Katana to Viewports. Events are generated by “EventTranslator” python plug-ins which convert Qt QEvents into attributes.

Public Types

enum MouseButtons¶

Mouse button enumeration used in the “button” event data attribute.

Values:

kNoButton = 0¶

kLeftButton = 1¶

kRightButton = 2¶

kMidButton = 4¶

kMiddleButton = kMidButton¶

kXButton1 = 8¶

kXButton2 = 16¶

enum KeyboardModifiers¶

Keyboard modifier enumeration used in the “modifiers” event data attribute.

Values:

kNoModifier = 0x00000000¶

kShiftModifier = 0x02000000¶

kControlModifier = 0x04000000¶

kAltModifier = 0x08000000¶

kMetaModifier = 0x10000000¶

kKeypadModifier = 0x20000000¶

kGroupSwitchModifier = 0x40000000¶

Public Functions

FnEventWrapper()¶

FnEventWrapper(const FnAttribute::GroupAttribute &attr)¶

FnEventWrapper(const FnEventWrapper &other)¶

~FnEventWrapper()¶

std::string getType() const¶

Returns the type of event as a string.

FnAttribute::Hash getTypeHash() const¶

Returns the hash of the eventType StringAttribute for faster comparisons.

FnAttribute::GroupAttribute getData() const¶

Returns a GroupAttribute containing the additional event data.

FnAttributeHandle getHandle() const¶

Returns an attribute handle for the event data.

FnAttributeHandle getRetainedHandle() const¶

Returns a retained attribute handle for the event data.