VS:MouseDown

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Return TRUE if a mouse down event has occurred within the active document window.

FUNCTION MouseDown(
          VAR pX,pY   :REAL) : BOOLEAN;

def vs.MouseDown():
    return (bool, (px, py))

Parameters

p

REAL

Coordinates of mouse click.

Remarks

This function returns a 2-dimensional point on the screen plane.

Example

VectorScript

REPEAT
UNTIL MouseDown(x1,y1);
REPEAT
UNTIL MouseDown(x2,y2);
MoveTo(x1,y1);
LineTo(x2,y2);

Python

down = False
while not down:
    down, pt = vs.MouseDown()  # pt is a tuple (x, y)

vs.AlrtDialog(str(pt))

Version

Availability: from All Versions