Renderer statements are typically placed at the end of a file. A Renderer is any interface component that occupies a separate window such as the Canvas editor or a System Graph.
LaserCanvas creates Renderer windows in the order in which the statements appear in the file. Thus, the last-created window is active when the file finishes loading.
If no renderers are defined within a file, LaserCanvas automatically creates a Canvas window.
Information about renderer statements:
Each renderer statement starts with the Renderer keyword, followed by the renderer type. The remaining lines defining the renderer are bracketed by { ... } braces. For example,
Renderer 2d { System = Sys_00966444 Window = 75, 70, 690, 200 }
The renderer type keyword must be one of the following: 1d, 2d, 3d, Inventory, Solver, SystemGraph, VertexGraph. See the following sections for information about each renderer type. The renderer statement must include at least the System definition.
Unlike optic properties, renderer properties must be constant expressions or equations that evaluate to constants.
The following properties apply to all renderers.
Property | Description |
System | Defines the system that the renderer applies to. The System line must specify the tag of a system defined within the file. If the specified system tag cannot be found, the renderer statement is ignored. |
Window | Defines the position of the renderer window, in pixels. The first two numbers specify the horizontal and vertical offset from the upper left-hand corner of the LaserCanvas window. The last two numbers are the width and height of the renderer window, respectively. |
The
Property | Description |
Flags | The sum of any or none of the following: |
1: Display optic icons on the graph | |
2: Highlight beam waists with a vertical line. | |
XMax | Maximum X-axis (Cavity Position) value. |
XMin | Minimum X-axis (Cavity Position) value. |
YMax | Maximum Y-Axis (Mode Size) value. |
YMin | Minimum Y-axis (Mode Size) value. |
The
Property | Description |
Flags | The sum of any or none of the following: |
1: Show the grid and snap to it when dragging optics. | |
2: Display distances between optics. | |
4: Display annotations for optics. | |
8: Highlight beam waists with a vertical line. | |
GridSize | The size of the grid, in mm. The grid is only used if flag 1 is specified. |
ModeScale | The display scale factor for the laser mode. |
OpticScale | The display size of optics, in mm. |
XMiddle | The cavity X position that is to be centred within the Canvas window, in mm. |
YMiddle | The cavity Y position that is to be centred within the Canvas window, in mm. |
Zoom | The display zoom factor. A zoom factor of 1 corresponds to 100% zoom. |
The
Property | Description |
CameraAngle | Tthe camera viewing angle, in degrees. |
CameraX | The camera X position, in mm. |
CameraY | The camera Y (elevation) position, in mm. |
CameraZ | The camera Z position, in mm. |
ModeScale | The display scale factor for the laser mode. |
OpticScale | The display size of optics, in mm. |
OriginX | The cavity Y position of the view centred in the window. |
OriginZ | The cavity X position of the view centred in the window. |
Flags | This property is currently not used. |
The
Property | Description |
Width0 Width1 Width2 Width3 Width4 Width5 Width6 | Specifies the column width for each column. The width is nominally in pixels, but the displayed column widths are adjusted so that the entire Inventory fits within the window. |
XScroll | This property is currently not used. |
YScroll | The vertical offset, in pixels, for the Inventory rows. |
The
Property | Description |
Equation | The function equation to be optimized. Unlike other equations, the Equation is enclosed in double quotation marks (") and can span multiple lines. |
FunctionTolerance | The accuracy to which the function is to be optimized. |
MaxIterations | The maximum number of iterations. |
SolveMode | Solve strategy. Can be one of the following: |
0: Solve for function minimum. | |
1: Solve for function maximum. | |
The
Property | Description |
Function | The system property to be plotted, see table below. |
Variable | The variable against which the Function is to be plotted. Must be one of the LaserCanvas variable names. |
XMax | Maximum X-Axis (variable) value. |
XMin | Minimum X-Axis (variable) value. |
YMax | Maximum Y-Axis (function) value. |
YMin | Minimum Y-Axis (function) value. |
The Function property must specify one of the following system properties to plot.
System Property | Description |
PhysicalLength | The physical cavity length of the system, in mm. |
OpticalLength | The optical cavity length of the system, in mm. |
ModeSpacing | The frequency spacing of adjacent cavity modes, in MHz. |
Stability | The system stability parameter g. |
The
Property | Description |
Function | The optic property to be plotted, see table below. |
Variable | The variable against which the Function is to be plotted. Must be one of the LaserCanvas variable names. |
Vertex | A tag specifying the optic whose property is to be graphed. |
XMax | Maximum X-Axis (variable) value. |
XMin | Minimum X-Axis (variable) value. |
YMax | Maximum Y-Axis (function) value. |
YMin | Minimum Y-Axis (function) value. |
The Function property must specify one of the following optic properties to plot.
Optic Property | Description |
Astigmatism | The distance between waists in the sagittal and tangential planes, in mm. |
Curvature | The wave front radius of curvature R, in mm, at the optic. |
Distance | The distance |
Mode | The mode size w, in um, at the optic. |
Waist | The waist size |