Module: Scalebars ()

Description:

This module displays a 2D coordinate system on top of the rendering area. The coordinates are calculated on a plane perpendicular to the viewing direction located at the focal distance of the camera. The focal distance is the point about which rotations are performed. In orthogonal projections the displayed distances are valid for all parts of the picture; in perspective projections only for the mentioned plane. The location and size of the coordinate system can be controlled by the ports. If fixed size option is unchecked, the module scales things to get "nice" numbers (no fractions). This module can be created by selecting Annotations / Scalebars within the main window's Project > Create Object... menu. This may be useful, for example, to produce snapshots that contain the scale. For better results, use a 1x1 tiling for the snapshot.

Ports:

Axis Options

Frame

Select the parts of the frame which should be drawn.

Reverse

Select whether x axis or y axis should be reversed, ie drawn from top to bottom for x-axis and right to left for y-axis.

Ticks

Select whether Ticks, Grid, and/or Text should be drawn.

SubTicks

Select whether SubTicks and SubGrid should be drawn.

Labeling Options

Unit

Units label (e.g., meters, mm, etc.) that is displayed at the axes. Note that the value of this port will not be editable when the unit management is activated in the preferences. In this case, the unit will be set to the global display coordinates one. For more information about Unit management in , please refer to the Unit management documentation.

Color

Color of the coordinate system.

LineWidth

Line width of axes and tick marks.

Font

Font type, size (in points) and color of displayed text (units and numbers).

Position and Size

PosX

The position of the origin (fraction of horizontal size of the viewing area).

PosY

The position of the origin (fraction of vertical size of the viewing area).

SizeX

Maximum size of the coordinate system (fraction of viewport size).

SizeY

Maximum size of the coordinate system (fraction of viewport size).

Custom Size

Custom Size

If custom size is ON, the modules scales things to get ``nice'' numbers (no fractions) and ports xFacor and yFactor are enabled. Otherwise, scale bars screen size is fixed in pixel size.

XFactor

Multiplicative factor of horizontal displayed text value. Default value is 1. This is used to add a virtual scale, /eg convert pixel size to model size.

YFactor

Multiplicative factor of vertical displayed text value. Default value is 1. This is used to add a virtual scale, /eg convert pixel size to model size.

Commands:

setTextFormat <format>
Sets the format used for the dispaled text in printf syntax. For example, the default format is %.4g.

getTextFormat
Returns the printf format used for the displayed text.