<node3d:canvas>.setRenderWorldOverlay

Render canvas over the world

<node3d:canvas>.setRenderWorldOverlay(
resolution	# [width, height]
fov	# degrees
distance
scene = viz.MainScene
)

resolution

The virtual [width, height] resolution of the canvas.

fov

The vertical field of view in degrees to project the canvas with.

distance

The distance in front of the viewpoint to project the canvas onto.

scene = viz.MainScene

The <scene> object to render within.

Remarks

This command will set the canvas to render over the world at the specified resolution. The canvas will be projected at the vertical fov to a distance in front of the view. The canvas reference frame is set to <node3d>.setReferenceFrame(viz.RF_VIEW).

This mode is typically used when rendering in stereo. Since the GUI will be rendered within the world, it will appear properly to the user in stereo.

The mouse style will most likely need to be changed to viz.CANVAS_MOUSE_VIRTUAL or viz.CANVAS_MOUSE_VISIBLE, depending on the input device used. See <node3d:canvas>.setMouseStyle for more information.

The default render mode of the canvas is world overlay, with the following settings:

canvas.setRenderWorldOverlay([1280,720], fov=50.0, distance=3.0)

Return Value

None