Pad++ Reference Manual

Widget-Specific Options

Name: background

Class: Background

Command-Line Switch: -background

Specifies the normal background color to use when displaying the widget.

Example:

			.pad config -background gray50

Name: closeEnough

Class: CloseEnough

Command-Line Switch: -closeEnough

Specifies a floating-point value indicating how close the mouse cursor must be to an item before it is considered to be "on" the item. Defaults to 3.0.

Name: cursor

Class: Cursor

Command-Line Switch: -cursor

Specifies the mouse cursor to be used for the widget. The value may have any of the forms acceptable to Tk_GetCursor.

Name: debugBB

Class: DebugBB

Command-Line Switch: -debugBB

Turns on and off display of bounding boxes. Default is 0.

Name: debugEvent

Class: DebugEvent

Command-Line Switch: -debugEvent

Turns on and off debugging of events. Default is 0. When event debugging is turned on, pad outputs a description of event handlers as they fire. In addition, if a break or event in a handler stops some events from firing, those events not fired are shown. By default, the event debugging output goes to stdout, however, it can be sent to a Tcl variable with the -debugOut configure option. Also note that PadDraw comes with a graphical interface that creates a GUI for seeing and examining events as they fire. This graphical event debugger can be used in other pad applications. See draw/debugevent.tcl.

Name: debugGen

Class: DebugGen

Command-Line Switch: -debugGen

Turns on and off general debugging. Default is 0.

Name: debugOut

Class: DebugOut

Command-Line Switch: -debugOut

Controls where debug output goes. By default, debug output is sent to stdout. However, the -debugOut configure option can specify a Tcl variable that all debug output will be appended to. It is then possible to set a Tcl trace on that variable to be notified whenever debug output is available. Currently, only -debugEvent uses the -debugOut variable.

Example: Evaluating ".pad config -debugOut foo" will cause all future debug output to be appended to the Tcl variable 'foo'.

Name: debugRegion

Class: DebugRegion

Command-Line Switch: -debugRegion

Turns on and off visual display of portion of the screen that actually gets re-rendered. Used to debug region management. Default is 0.

Name: defaultEventHandlers

Class: DefaultEventHandlers

Command-Line Switch: -defaultEventHandlers

Turns on and off the default navigation event handlers. The default handlers are very simple. They allow basic panning with mouse button #1, zooming in with button #2, and zooming out with button #3. Default is 0.

Name: defaultRenderLevel

Class: DefaultRenderLevel

Command-Line Switch: -defaultRenderLevel

Specifies the default render level to use to display the Pad if no specific level is specified. The render level is generally used for efficiency where render level 0 is the fastest and least pretty way to render the pad (text is uglier, smaller items are not rendered, some items are rendered at a lower resolution). As the render level goes higher, the pad is rendered slower and prettier

Name: desiredFrameRate

Class: DesiredFrameRate

Command-Line Switch: -desiredFrameRate

Specifies the desired frame rate (in frames per second). This number is used by the Pad++ rendering engine to decide how to render the scene while animating. If a high frame rate is requested, small objects may not be rendered (see -alwaysrender) flag, and some objects may be rendered at low resolution. The default is 20 frames/second.

Name: dissolveSpeed

Class: DissolveSpeed

Command-Line Switch: -dissolveSpeed

Specifies how quickly dissolves should occur upon refinement. When the pad widget refines, it uses a dissolve effect instead of a simple buffer swap. The dissolve is controlled by -dissolveSpeed. This option may vary between 0 and 3 where 0 is a simple buffer swap, 1 is a fast dissolve, and 3 is the slowest dissolve. The default is 2.

Name: doubleBuffer

Class: DoubleBuffer

Command-Line Switch: -doubleBuffer

Specifies if the system should use double buffering for rendering. If doubleBuffer is set to 0 (off), rendering will be a little faster, but the screen will flash quite a bit. Mostly useful for debugging. Default is 1.

Name: fastPan

Class: FastPan

Command-Line Switch: -fastPan

Pad++ normally does fast pans, i.e., copying the portion of the screen that doesn't change, and re-rendering the new portion. This results in an approximation which can make the view be off by up to a half of a pixel. Fast panning can be disabled by setting this flag to 0 which results in slower but more accurate pans. Default is 1.

Name: fontCacheSize

Class: fontCacheSize

Command-Line Switch: -fontCacheSize

Pad++ employs a simple caching mechanism when drawing text in Type1 fonts. The caching mechanism remembers what size, font and bitmap it used when it last drew a particular character, and if that character is drawn again at the same size and font, Pad++ reuses the last bitmap image for that character rather than generating the bitmap for the character from its outline description. This greatly increases the speed of rendering large quantities of text.

You can configure the caching mechanism using the -fontCacheSize option. The font cache size is measured in Kilobytes (rounded to the nearest 100K). Setting -fontCacheSize to 0 turns off font caching, and characters are always drawn from their outline descriptions. The default value is 100 which produces significantly faster font rendering than using no font cache. Values above 100 have a lesser impact on performance, but may be effective for applications which use a lot of text with different fonts and sizes.

Name: gamma

Class: Gamma

Command-Line Switch: -gamma

Specifies 'gamma' used for allocating colors for images. This number controls how light or dark an image appears to be. Larger numbers will make images appear lighter. Default is 1.0.

Name: height

Class: Height

Command-Line Switch: -height

Specifies the height of the Pad in pixels. Defaults to 400.

Name: heightmmofscreen

Class: HeightMMOfScreen

Command-Line Switch: -heightmmofscreen

Specifies the height of the physical screen in millimeters. Normally, this information is given by the X server, but sometimes it is incorrect (for example, on some laptops). If it is incorrect, coordinates on the Pad++ surface will be incorrect. If this value is set to 0, the X server information will be used. Defaults to 0.

Name: interruptible

Class: interruptible

Command-Line Switch: -interruptible

If this flag is true (1), then animations and slow renders will be interrupted by events (mouse and keyboard). Defaults to true (1).

Name: maxZoom

Class: MaxZoom

Command-Line Switch: -maxzoom

This controls the maximum zoom (in and out) that any view is allowed. This way, it not possible to crash pad by zooming in or out too far. It defaults to 100,000,000 which gives 16 orders of magnitude of zooming (8 in and 8 out). Note that the amount one can zoom in is determined by the product of the (x, y) position and the zoom. So, while you can zoom into the position (0, 0, 100000000), you can only zoom into (1000, 1000, 100000). Setting -maxzoom to 0 disables the checking.

Name: mediumObjSize

Class: MediumObjSize

Command-Line Switch: -mediumObjSize

Pad++ tries to keep up the display rate, even when the scene gets complicated. If the system becomes slower than the requested frame rate, it both stops drawing small objects, and it draws medium-sized objects in a very ugly fashion. This option configures the size below which objects are considered to be medium-sized. Default is 100 pixels. (Also see -smallObjSize configuration option.)

Name: refinementDelay

Class: RefinementDelay

Command-Line Switch: -refinementDelay

Specifies the delay in milliseconds after the last X event to start refinement. Default is 1000.

Name: smallObjSize

Class: SmallObjSize

Command-Line Switch: -smallObjSize

Pad++ tries to keep up the display rate, even when the scene gets complicated. If the system becomes slower than the requested frame rate, it both stops drawing small objects, and it draws medium-sized objects in a very ugly fashion. This option configures the size below which objects are considered to be small-sized. Default is 10 pixels. (Also see -mediumObjSize configuration option.)

Name: sync

Class: Sync

Command-Line Switch: -sync

Specifies if X event synchronization should be turned on. When it is on, the X server executes every command as it is executed rather than caching them and executing commands in groups. Generally useful just for debugging. Default is 0.

Name: units

Class: Units

Command-Line Switch: -units

Specifies unit dimensions for all coordinates used by Pad++. It can be any of "points", "mm", "inches", or "pixels". Default is points.

Name: width

Class: Width

Command-Line Switch: -width

Specifies the width of the Pad in pixels. Defaults to 400.

Name: widthmmofscreen

Class: WidthMMOfScreen

Command-Line Switch: -widthmmofscreen

Specifies the width of the physical screen in millimeters. Normally, this information is given by the X server, but sometimes it is incorrect (for example, some laptops). If it is incorrect, coordinates on the Pad++ surface will be incorrect. If this value is set to 0, the X server information will be used. Defaults to 0.

Copyright Computer Science Department, The University of New Mexico

Web Accessibility