AIToolMessage Struct Reference

The contents of a tool message. More...

#include <AITool.h>

List of all members.

Public Attributes
SPMessageData	d
	The message data.
AIToolHandle	tool
	The tool plug-in receiving the message.
AIRealPoint	cursor
	The location of the mouse cursor in page coordinates.
AIToolPressure	pressure
	The amount of force being applied to a pressure-sensitive input device, such as a graphics tablet.
AIEvent *	event
	For mouse selectors, the ADM event record for the mouse event, containing additional information about the event.
AIToolPressure	stylusWheel
	For graphic tablets, tangential pressure on the finger wheel of the airbrush tool.
AIToolAngle	tilt
	How the tool is angled, also called altitude or elevation.
AIToolAngle	bearing
	The direction of tilt, measured clockwise in degrees around the Z axis, also called azimuth,.
AIToolAngle	rotation
	Rotation of the tool, measured clockwise in degrees around the tool's barrel.
ai::int32	flags
	To give more information to listeners of AIToolMessage, it will be composed of values from AIToolMessageFlags.
ai::AutoBuffer < AIEventHistoryData >	eventHistoryData
	The history data associated with the event.

---

Detailed Description

The contents of a tool message.

---

Member Data Documentation

AIToolAngle AIToolMessage::bearing

The direction of tilt, measured clockwise in degrees around the Z axis, also called azimuth,.

AIRealPoint AIToolMessage::cursor

The location of the mouse cursor in page coordinates.

SPMessageData AIToolMessage::d

The message data.

AIEvent* AIToolMessage::event

For mouse selectors, the ADM event record for the mouse event, containing additional information about the event.

(ADM is no longer supported).

ai::AutoBuffer<AIEventHistoryData> AIToolMessage::eventHistoryData

The history data associated with the event.

ai::int32 AIToolMessage::flags

To give more information to listeners of AIToolMessage, it will be composed of values from AIToolMessageFlags.

AIToolPressure AIToolMessage::pressure

The amount of force being applied to a pressure-sensitive input device, such as a graphics tablet.

Use AIToolSuite::SystemHasPressure() to determine if such a device is in use.

AIToolAngle AIToolMessage::rotation

Rotation of the tool, measured clockwise in degrees around the tool's barrel.

AIToolPressure AIToolMessage::stylusWheel

For graphic tablets, tangential pressure on the finger wheel of the airbrush tool.

AIToolAngle AIToolMessage::tilt

How the tool is angled, also called altitude or elevation.

AIToolHandle AIToolMessage::tool

The tool plug-in receiving the message.

If the plug-in has more than one tool installed, it can determine which one was selected by comparing this handle to those it has saved in the globals variable.

---

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

• AITool.h