#include <omicronConnectorClient.h>

Public Types
enum	ServiceType { ServiceTypePointer, ServiceTypeMocap, ServiceTypeKeyboard, ServiceTypeController, ServiceTypeUi, ServiceTypeGeneric, ServiceTypeBrain, ServiceTypeWand, ServiceTypeSpeech }
	Enumerates the service classes supported by omicron. More...

enum	Type { Select = 0, Toggle = 1, ChangeValue = 2, Update = 3, Move = 4, Down = 5, Up = 6, Trace = 7, Connect = Trace, Untrace = 8, Disconnect = Untrace, Click = 9, Zoom = 15, Split = 18, Rotate = 21, Null = 666 }
	#PYAPI Supported event types. More...

enum	Flags { Left = 1 << 0, Button1 = 1 <<0, Right = 1 << 1, Button2 = 1 << 1, Middle = 1 << 2, Button3 = 1 << 2, Ctrl = 1 << 3, SpecialButton1 = 1 << 3, Alt = 1 << 4, SpecialButton2 = 1 << 4, Shift = 1 << 5, SpecialButton3 = 1 << 5, Button4 = 1 << 6, Enter = 1 << 6, Button5 = 1 << 7, Backspace = 1 << 7, Button6 = 1 << 8, Button7 = 1 << 9, ButtonUp = 1 << 10, ButtonDown = 1 << 11, ButtonLeft = 1 << 12, ButtonRight = 1 << 13, Button8 = 1 << 15, Button9 = 1 << 16, Processed = 1 << 14, Exclusive = 1 << 17, User = 1 << 18 }
	#PYAPI Defines some generic input event flags More...

enum	ExtraDataType { ExtraDataNull, ExtraDataFloatArray, ExtraDataIntArray, ExtraDataVector3Array, ExtraDataString, ExtraDataKinectSpeech }

enum	OmicronSkeletonJoint { OMICRON_SKEL_HIP_CENTER, OMICRON_SKEL_HEAD, OMICRON_SKEL_NECK, OMICRON_SKEL_TORSO, OMICRON_SKEL_WAIST, OMICRON_SKEL_LEFT_COLLAR, OMICRON_SKEL_LEFT_SHOULDER, OMICRON_SKEL_LEFT_ELBOW, OMICRON_SKEL_LEFT_WRIST, OMICRON_SKEL_LEFT_HAND, OMICRON_SKEL_LEFT_FINGERTIP, OMICRON_SKEL_LEFT_HIP, OMICRON_SKEL_LEFT_KNEE, OMICRON_SKEL_LEFT_ANKLE, OMICRON_SKEL_LEFT_FOOT, OMICRON_SKEL_RIGHT_COLLAR, OMICRON_SKEL_RIGHT_SHOULDER, OMICRON_SKEL_RIGHT_ELBOW, OMICRON_SKEL_RIGHT_WRIST, OMICRON_SKEL_RIGHT_HAND, OMICRON_SKEL_RIGHT_FINGERTIP, OMICRON_SKEL_RIGHT_HIP, OMICRON_SKEL_RIGHT_KNEE, OMICRON_SKEL_RIGHT_ANKLE, OMICRON_SKEL_RIGHT_FOOT, OMICRON_SKEL_SPINE, OMICRON_SKEL_SHOULDER_CENTER, OMICRON_SKEL_LEFT_THUMB, OMICRON_SKEL_RIGHT_THUMB, OMICRON_SKEL_COUNT }
	Joint enumerations for Kinect (Uses OpenNI's enumerations with additional Kinect for Windows values) See MSKinectService.h, XnTypes.h (OpenNI), or NuiSensor.h (Kinect for Windows) More...

enum	DeviceTagMask { DTServiceIdMask = 0x0000ffff, DTUserIdMask = 0xffff0000, DTUserIdOffset = 16, DTServiceIdOffset = 0 }
	Bit masks used to read the service id and user id from the event device tag. More...

Inheritance diagram for omicron::EventBase:

Member Enumeration Documentation

enum omicron::EventBase::DeviceTagMask

Bit masks used to read the service id and user id from the event device tag.

Enumerator
DTServiceIdMask
DTUserIdMask
DTUserIdOffset
DTServiceIdOffset

enum omicron::EventBase::ExtraDataType

Enumerator
ExtraDataNull
ExtraDataFloatArray
ExtraDataIntArray
ExtraDataVector3Array
ExtraDataString
ExtraDataKinectSpeech

enum omicron::EventBase::Flags

#PYAPI Defines some generic input event flags

Enumerator
Left	Used for right mouse button or equivalent events.
Button1	Generic name for left / main button.
Right	Used for right mouse button or equivalent events.
Button2	Generic name for right / secondary button.
Middle	Used for middle mouse button or equivalent events.
Button3	Generic name for middle / tertiary button.
Ctrl	Used for ctrl key presses or equivalent events.
SpecialButton1	Generic name for control key / primary modifier button.
Alt	Used for ctrl key presses or equivalent events.
SpecialButton2	Generic name for alt key / secondary modifier button.
Shift	Used for ctrl key presses or equivalent events.
SpecialButton3	Generic name for shift key / tertiary modifier button.
Button4	Generic name for additional button 4.
Enter	Used for confirm button prsses or equivalent events.
Button5	Generic name for additional button 5.
Backspace	Used for backspace button presses or equivalent events.
Button6	Generic name for additional button 6.
Button7	Generic name for additional button 7.
ButtonUp	Generic name for digital up button.
ButtonDown	Generic name for digital down button.
ButtonLeft	Generic name for digital left button.
ButtonRight	Generic name for digital right button.
Button8	Generic name for additional button 8.
Button9	Generic name for additional button 9.
Processed	INTERNAL: Used to mark events that have been processed.
Exclusive	INTERNAL: Used to mark events that are sent to a single endpoint instead of being broadcast.
User	User flags should offset this value: 14 user flags available (USER to USER << 18)

enum omicron::EventBase::OmicronSkeletonJoint

Joint enumerations for Kinect (Uses OpenNI's enumerations with additional Kinect for Windows values) See MSKinectService.h, XnTypes.h (OpenNI), or NuiSensor.h (Kinect for Windows)

Enumerator
OMICRON_SKEL_HIP_CENTER
OMICRON_SKEL_HEAD
OMICRON_SKEL_NECK
OMICRON_SKEL_TORSO
OMICRON_SKEL_WAIST
OMICRON_SKEL_LEFT_COLLAR
OMICRON_SKEL_LEFT_SHOULDER
OMICRON_SKEL_LEFT_ELBOW
OMICRON_SKEL_LEFT_WRIST
OMICRON_SKEL_LEFT_HAND
OMICRON_SKEL_LEFT_FINGERTIP
OMICRON_SKEL_LEFT_HIP
OMICRON_SKEL_LEFT_KNEE
OMICRON_SKEL_LEFT_ANKLE
OMICRON_SKEL_LEFT_FOOT
OMICRON_SKEL_RIGHT_COLLAR
OMICRON_SKEL_RIGHT_SHOULDER
OMICRON_SKEL_RIGHT_ELBOW
OMICRON_SKEL_RIGHT_WRIST
OMICRON_SKEL_RIGHT_HAND
OMICRON_SKEL_RIGHT_FINGERTIP
OMICRON_SKEL_RIGHT_HIP
OMICRON_SKEL_RIGHT_KNEE
OMICRON_SKEL_RIGHT_ANKLE
OMICRON_SKEL_RIGHT_FOOT
OMICRON_SKEL_SPINE
OMICRON_SKEL_SHOULDER_CENTER
OMICRON_SKEL_LEFT_THUMB
OMICRON_SKEL_RIGHT_THUMB
OMICRON_SKEL_COUNT

enum omicron::EventBase::ServiceType

Enumerates the service classes supported by omicron.

Each service class generates events with the same structure.

Enumerator
ServiceTypePointer
ServiceTypeMocap
ServiceTypeKeyboard
ServiceTypeController
ServiceTypeUi
ServiceTypeGeneric
ServiceTypeBrain
ServiceTypeWand
ServiceTypeSpeech

enum omicron::EventBase::Type

#PYAPI Supported event types.

The python API exposed this enum in the EventType object.

Enumerator
Select	Select: generated when the source of the event gets selected or activated. Used primarily for use iterface controls.
Toggle	Toggle: generated when some boolean state in the event source changes. Can represent state changes in physical switches and buttons, or in user interface controls like check boxes and radio buttons.
ChangeValue	ChangeValue: generated when the source of an event changes it's internal value or state. Different from Update because ChangeValue is not usually fired at regular intervals, while Update events are normally sent at a constant rate.
Update	Update: Generated when the soruce of an event gets updated (what 'update') means depends on the event source.
Move	Move: Generated whenever the source of an event moves.
Down	Down: generated when the source of an event goes to a logical 'down' state (i.e. touch on a surface or a mouse button press count as Down events)
Up	Up: generated when the source of an event goes to a logical 'up' state (i.e. remove touch from a surface or a mouse button release count as Up events)
Trace	Trace: generated when a new object is identified by the device managed by the input service (i.e head tracking, or a mocap system rigid body).
Connect	Alternate name for Trace events.
Untrace	Trace: generated when a traced object is lost by the device managed by the input service (i.e head tracking, or a mocap system rigid body).
Disconnect	Alternate name for Untrace events.
Click	Click: generated on a down followed by an immediate up event. parameters: position
Zoom	Zoom: zoom event.
Split	Split: generated during a split/zoom gesture. parameters: position (center of gesture) pointSet[0, 1] (individual finger positions), value[0] (delta distance) value[1] (delta ratio) .
Rotate	Rotate: generated when an event source is stationary while a second source is rotating around the first. parameters: position (center of gesture) pointSet[0, 1] (individual finger positions), rotation[0] (degrees).
Null	Null: generic null value for event type.

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

C:/dev/omegalib/release/src/omicron/include/connector/omicronConnectorClient.h

Public Types

Member Enumeration Documentation