<viz:mouse>.setTrap

Vizard 8 » Command Index » Vizard modules » viz » <viz:mouse>.setTrap

8.0

<viz:mouse>.setTrap

This command will trap the mouse inside the graphics window

<viz:mouse>.setTrap(
restrict	# ON or OFF
)

restrict

Can be either viz.ON, viz.OFF, or viz.TOGGLE

Remarks

If viz.ON is specified then the mouse will be trapped inside the graphics window and cannot leave. If viz.OFF is specified then the mouse is free to roam the entire screen.

Return Value

None

Example

viz.mouse.setTrap(viz.ON)