debugMode()

Adds a grid and an axes icon to clarify orientation in 3D sketches.

debugMode() adds a grid that shows where the “ground” is in a sketch. By default, the grid will run through the origin (0, 0, 0) of the sketch along the XZ plane. debugMode() also adds an axes icon that points along the positive x-, y-, and z-axes. Calling debugMode() displays the grid and axes icon with their default size and position.

There are four ways to call debugMode() with optional parameters to customize the debugging environment.

The first way to call debugMode() has one parameter, mode. If the system constant GRID is passed, as in debugMode(GRID), then the grid will be displayed and the axes icon will be hidden. If the constant AXES is passed, as in debugMode(AXES), then the axes icon will be displayed and the grid will be hidden.

The second way to call debugMode() has six parameters. The first parameter, mode, selects either GRID or AXES to be displayed. The next five parameters, gridSize, gridDivisions, xOff, yOff, and zOff are optional. They’re numbers that set the appearance of the grid (gridSize and gridDivisions) and the placement of the axes icon (xOff, yOff, and zOff). For example, calling debugMode(20, 5, 10, 10, 10) sets the gridSize to 20 pixels, the number of gridDivisions to 5, and offsets the axes icon by 10 pixels along the x-, y-, and z-axes.

The third way to call debugMode() has five parameters. The first parameter, mode, selects either GRID or AXES to be displayed. The next four parameters, axesSize, xOff, yOff, and zOff are optional. They’re numbers that set the appearance of the size of the axes icon (axesSize) and its placement (xOff, yOff, and zOff).

The fourth way to call debugMode() has nine optional parameters. The first five parameters, gridSize, gridDivisions, gridXOff, gridYOff, and gridZOff are numbers that set the appearance of the grid. For example, calling debugMode(100, 5, 0, 0, 0) sets the gridSize to 100, the number of gridDivisions to 5, and sets all the offsets to 0 so that the grid is centered at the origin. The next four parameters, axesSize, xOff, yOff, and zOff are numbers that set the appearance of the size of the axes icon (axesSize) and its placement (axesXOff, axesYOff, and axesZOff). For example, calling debugMode(100, 5, 0, 0, 0, 50, 10, 10, 10) sets the gridSize to 100, the number of gridDivisions to 5, and sets all the offsets to 0 so that the grid is centered at the origin. It then sets the axesSize to 50 and offsets the icon 10 pixels along each axis.