Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Member Functions | Static Public Member Functions | Static Public Attributes | Friends | List of all members
hdi::core::ToolMessage Class Reference

Received for ToolEditMessageType, ToolTrackMessageType, ToolMouseDownMessageType, ToolMouseDragMessageType, ToolMouseUpMessageType, ToolSelectMessageType, ToolReselectMessageType, ToolDeselectMessageType, ToolDecreaseDiameterMessageType, ToolIncreaseDiameterMessageType, ToolAlternateSelectionQueryMessageType, ToolAlternateSelectionActivateMessageType, and ToolAlternateSelectionDeactivateMessageType. More...

#include <hdicoreMessage.h>

Inheritance diagram for hdi::core::ToolMessage:
Inheritance graph
[legend]
Collaboration diagram for hdi::core::ToolMessage:
Collaboration graph
[legend]

Public Member Functions

virtual ~ToolMessage ()
 Destructs a ToolMessage object. More...
 
Tool *const tool () const
 Gets the Tool object to which the message applies. More...
 
ArtboardPoint cursor () const
 Gets the current position of the cursor on the artboard. More...
 
double pressure () const
 Gets the pressure of the input device. More...
 
double stylusWheel () const
 Gets the tangential pressure on the finger wheel of the airbrush tool. More...
 
Angle tilt () const
 Gets how the tool is angled; also called altitude or elevation. More...
 
Angle bearing () const
 Gets the direction of tilt, measured clockwise around the z-axis; also called azimuth. More...
 
Angle rotation () const
 Gets the rotation of the tool, measure clockwise around the tool's barrel. More...
 
ModifierKey modifiers () const
 Gets the modifier keys that were present when the message was received. More...
 
- Public Member Functions inherited from hdi::core::Message
virtual ~Message ()
 Destructs a Message object. More...
 
virtual MessageType type () const
 Gets the type of message data the target object represents. More...
 

Static Public Member Functions

static Angle normalTilt ()
 Gets a normal/default pen tilt angle. More...
 
static Angle normalBearing ()
 Gets a normal/default pen bearing angle. More...
 
static Angle normalRotation ()
 Gets a normal/default pen rotation angle. More...
 

Static Public Attributes

static const double normalPressure
 Normal/default tool pressure value (tool pressure values are in the range [0.0, 1.0])
 

Friends

class Dispatcher
 

Additional Inherited Members

- Protected Member Functions inherited from hdi::core::Message
 Message ()
 Internal use only. More...
 
 Message (const Message &)
 Unused. More...
 
Messageoperator= (const Message &)
 Unused. More...
 
- Protected Attributes inherited from hdi::core::Message
void * _data
 Stores private implementation data.
 

Detailed Description

Received for ToolEditMessageType, ToolTrackMessageType, ToolMouseDownMessageType, ToolMouseDragMessageType, ToolMouseUpMessageType, ToolSelectMessageType, ToolReselectMessageType, ToolDeselectMessageType, ToolDecreaseDiameterMessageType, ToolIncreaseDiameterMessageType, ToolAlternateSelectionQueryMessageType, ToolAlternateSelectionActivateMessageType, and ToolAlternateSelectionDeactivateMessageType.

Constructor & Destructor Documentation

virtual hdi::core::ToolMessage::~ToolMessage ( )
virtual

Destructs a ToolMessage object.

Author
GW
Date
08/2013

Member Function Documentation

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
ArtboardPoint hdi::core::ToolMessage::cursor ( ) const

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
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
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
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
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
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])
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
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])
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* 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