Received for ToolEditMessageType, ToolTrackMessageType, ToolMouseDownMessageType, ToolMouseDragMessageType, ToolMouseUpMessageType, ToolSelectMessageType, ToolReselectMessageType, ToolDeselectMessageType, ToolDecreaseDiameterMessageType, ToolIncreaseDiameterMessageType, ToolAlternateSelectionQueryMessageType, ToolAlternateSelectionActivateMessageType, and ToolAlternateSelectionDeactivateMessageType.
More...
#include <hdicoreMessage.h>
|
virtual | ~ToolMessage () |
| Destructs a ToolMessage object.
|
|
Tool *const | tool () const |
| Gets the Tool object to which the message applies.
|
|
ArtboardPoint | cursor () const |
| Gets the current position of the cursor on the artboard.
|
|
double | pressure () const |
| Gets the pressure of the input device.
|
|
double | stylusWheel () const |
| Gets the tangential pressure on the finger wheel of the airbrush tool.
|
|
Angle | tilt () const |
| Gets how the tool is angled; also called altitude or elevation.
|
|
Angle | bearing () const |
| Gets the direction of tilt, measured clockwise around the z-axis; also called azimuth.
|
|
Angle | rotation () const |
| Gets the rotation of the tool, measure clockwise around the tool's barrel.
|
|
ModifierKey | modifiers () const |
| Gets the modifier keys that were present when the message was received.
|
|
virtual | ~Message () |
| Destructs a Message object.
|
|
virtual MessageType | type () const |
| Gets the type of message data the target object represents.
|
|
virtual void * | rawData () const |
| Gets the raw Illustrator message data struct.
|
|
|
static const double | normalPressure |
| Normal/default tool pressure value (tool pressure values are in the range [0.0, 1.0])
|
|
Received for ToolEditMessageType, ToolTrackMessageType, ToolMouseDownMessageType, ToolMouseDragMessageType, ToolMouseUpMessageType, ToolSelectMessageType, ToolReselectMessageType, ToolDeselectMessageType, ToolDecreaseDiameterMessageType, ToolIncreaseDiameterMessageType, ToolAlternateSelectionQueryMessageType, ToolAlternateSelectionActivateMessageType, and ToolAlternateSelectionDeactivateMessageType.
◆ ~ToolMessage()
virtual hdi::core::ToolMessage::~ToolMessage |
( |
| ) |
|
|
virtual |
◆ bearing()
Angle hdi::core::ToolMessage::bearing |
( |
| ) |
const |
Gets the direction of tilt, measured clockwise around the z-axis; also called azimuth.
- Author
- GW
- Date
- 09/2013
- Returns
- The tool bearing
◆ cursor()
Gets the current position of the cursor on the artboard.
- Author
- GW
- Date
- 08/2013
- Returns
- The position of the cursor at the time the message was received
◆ modifiers()
ModifierKey hdi::core::ToolMessage::modifiers |
( |
| ) |
const |
Gets the modifier keys that were present when the message was received.
- Author
- GW
- Date
- 08/2013
- Returns
- The modifier keys that were pressed
◆ normalBearing()
static Angle hdi::core::ToolMessage::normalBearing |
( |
| ) |
|
|
static |
Gets a normal/default pen bearing angle.
- Author
- GW
- Date
- 10/2013
- Returns
- An angle for the default pen bearing
◆ normalRotation()
static Angle hdi::core::ToolMessage::normalRotation |
( |
| ) |
|
|
static |
Gets a normal/default pen rotation angle.
- Author
- GW
- Date
- 10/2013
- Returns
- An angle for the default pen rotation
◆ normalTilt()
static Angle hdi::core::ToolMessage::normalTilt |
( |
| ) |
|
|
static |
Gets a normal/default pen tilt angle.
- Author
- GW
- Date
- 10/2013
- Returns
- An angle for the default pen tilt
◆ pressure()
double hdi::core::ToolMessage::pressure |
( |
| ) |
const |
Gets the pressure of the input device.
- Author
- GW
- Date
- 08/2013
- Returns
- The pressure at the time the message was received, or normalPressure if the device is not pressure-sensitive (the value is in range [0.0,1.0])
◆ rotation()
Angle hdi::core::ToolMessage::rotation |
( |
| ) |
const |
Gets the rotation of the tool, measure clockwise around the tool's barrel.
- Author
- GW
- Date
- 09/2013
- Returns
- The tool rotation
◆ stylusWheel()
double hdi::core::ToolMessage::stylusWheel |
( |
| ) |
const |
Gets the tangential pressure on the finger wheel of the airbrush tool.
- Author
- GW
- Date
- 09/2013
- Returns
- The finger wheel pressure, or normalPressure if the device is not pressure-sensitive (the value is in range [0.0,1.0])
◆ tilt()
Angle hdi::core::ToolMessage::tilt |
( |
| ) |
const |
Gets how the tool is angled; also called altitude or elevation.
- Author
- GW
- Date
- 09/2013
- Returns
- The tool tilt
◆ tool()
Tool *const hdi::core::ToolMessage::tool |
( |
| ) |
const |
Gets the Tool object to which the message applies.
- Author
- GW
- Date
- 08/2013
- Returns
- The tool for which a message was received