Vizard 6 » Command Index » Vizard modules » viz » <viz:mouse>.setVisible
6.2

<viz:mouse>.setVisible

This command changes the system visibility of the cursor

 

<viz:mouse>.setVisible(  
state  
)  

 

state
Specifies how to change the state of the cursor:
viz.ON
viz.OFF
viz.TOGGLE
viz.MOUSE_AUTO_HIDE

Remarks

Use this command to change the visibility of the mouse.

If viz.MOUSE_AUTO_HIDE is specified, then the mouse cursor will be automatically hidden if it has not been interacted with for a certain period of time. The <viz:mouse>.setAutoHideDelay command can be used to control the delay time for hiding the mouse. The default delay time is 2 seconds.

Return Value

None

Example

viz.mouse.setVisible(viz.ON)

See also

<viz:mouse>.getVisible
<viz:mouse>.setAutoHideDelay
<viz:mouse>.getAutoHideDelay