SDK:Setting Tool Status: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (1 revision) |
(No difference)
|
Latest revision as of 15:39, 12 August 2013
.SDK|SDK ..SDK:Types|SDK Types ..SDK:Using the SDK|Using the SDK ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference
Tool Status
VectorWorks sends kToolGetStatus to the plug-in so it can determine how many clicks the user has to make in order the tool to be completed and kToolHandleComplete to be send.
Messages
This event doesn't use any additional information from the message parameters (SDK:Tool Plug-in Main Function).
Returns
A tool can return the result of:
- ISDK::OnePointToolStatus -- The tool will require single click from the user before sending kToolHandleComplete;
- ISDK::ClickDragToolStatus -- ???
- ISDK::TwoPointToolStatus -- The tool will require two clicks form the user before sending kToolHandleComplete;
- ISDK::ThreePointToolStatus -- The tool will require three clicks from the user before sending kToolHandleComplete;
- ISDK::PolyToolStatus -- The tool will require multiple clicks from the user. Double click or clicking on the first clicked point will send kToolHandleComplete.
In addition the tool can provide custom status behavior by returning one of the following:
- kToolCompleted
- kToolCollectingPoints
- kToolWaitingForFirstPoint