VS:GetPt: Difference between revisions
mNo edit summary |
No edit summary |
||
(One intermediate revision by one other user not shown) | |||
Line 26: | Line 26: | ||
REAL | REAL | ||
Returns coordinates of mouse click. | Returns coordinates of mouse click. | ||
</line> | |||
<line> | |||
callback | |||
FUNCTION | |||
Python only! A callback function that will be executed when the tool finishes. The callback receives the point | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
Line 33: | Line 38: | ||
<remark> | <remark> | ||
In Python this function will <b>NOT</b> block execution. It will execute a callback function with the resulted point. | In Python this function will <b>NOT</b> block execution. It will execute a callback function with the resulted point. | ||
[MaKro 6/2018]: ... in a tool consider using VS:vstGetCurrPt2D ... | |||
</remark> | </remark> | ||
Line 60: | Line 67: | ||
vs.GetPt( PickPointCallback ) | vs.GetPt( PickPointCallback ) | ||
</code> | </code> | ||
</sample> | </sample> | ||
Latest revision as of 21:56, 20 January 2022
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Procedure GetPt switches the cursor to selection mode and allows the user to select a point in a VectorWorks document. This cannot be used if there is a function anywhere in the calling chain.
PROCEDURE GetPt(
VAR pX,pY :REAL);
def vs.GetPt(callback): return None
Parameters
p REAL Returns coordinates of mouse click. callback FUNCTION Python only! A callback function that will be executed when the tool finishes. The callback receives the point
Remarks
In Python this function will NOT block execution. It will execute a callback function with the resulted point.
[MaKro 6/2018]: ... in a tool consider using VS:vstGetCurrPt2D ...
Example
PROCEDURE Example; VAR pt :POINT; BEGIN GetPt(pt.x, pt.y); Message(pt); END; RUN(Example);
Python:
import vs; def DoIt(h1): vs.AlrtDialog( "we're in", h1 ) def PickPointCallback(pt): vs.ForEachObjectAtPoint(DoIt, 0, 0, pt[0], pt[1], 5) vs.AlrtDialog( "show let you pick a point, and then show a dialog with the object's handle" ) vs.GetPt( PickPointCallback )
Version
Availability: from All Versions
See Also
VS Functions:
VS:GetPt | VS:GetPtL | VS:GetPt3D | VS:GetPtL3D | VS:GetLine | VS:GetLine3D | VS:GetRect | VS:GetRect3D | VS:TrackObject
[[VS:GetPt]] | [[VS:GetPtL]] | [[VS:GetPt3D]] | [[VS:GetPtL3D]] | [[VS:GetLine]] | [[VS:GetLine3D]] | [[VS:GetRect]] | [[VS:GetRect3D]] |
[[VS:TrackObject]]