Display Functions

Display functions control how the simulation is viewed and captured. These functions allow you to adjust the camera position, configure visual settings, and capture snapshots of the simulation environment.

$FMSTPS	Set tool path trace line style
$FMSCMRA	Set camera position and/or display settings
$FMSPIC	Take a picture of the simulation

The $FMSTPS Function

Sets tool path tracing properties Returns: Numeric (always returns 1)

The first form of the $FMSTPS function sets the Simulation window tool path tracing color, width and pattern, overriding the default tracing format. The red, green and blue parameters are values in the range 0-255, specifying the intensity of the three different color components that when combined will produce the desired color. The width of the trace can be specified in screen pixels, in the range 1-5 (default is 1). A drawing pattern can also be specified, in the range 0-5 (default is 0).

0:

1:

2:

3:

4:

5:

transparent

The second form of the $FMSTPS function enables or disables custom tool path styling. When enabled (ON), VM will output tool path tracing in the style last defined. When disabled (OFF), VM will output tool path tracing in the default style as defied in the Simulation»Options dialog Tool Path tab.

The $FMSCMRA Function

Set the Simulation window viewpoint Returns: Numeric

The $FMSCMRA function can be used to set the Simulation window viewpoint to a predefined model camera position, equivalent to selecting one of the CTRL 0 through CTRL 9 hot-key combinations. Specify the camera position using a whole number n in the range 0-9. No camera motion is taken if the predefined position has not been defined.

This function can also be used to set various Simulation window display settings, by optionally specifying a series of display property names and desired property values. Property name keyword(s) are case insensitive strings that can be abbreviated to the bolded text as shown in the table below. Property values with a few exceptions are numeric. Names and values can be specified as any combination of variables and/or constants, including sequences.

Menu setting	Property name	Values(s)
Camera»Fit	CAMERA.FIT	-1:as-is, 0:default, n:$FMSID of object(s) to fit in view (multiple IDs permitted)
Camera»Center	CAMERA.CENTER	-1:as-is, 0:default, n:$FMSID of object(s) to center in view (multiple IDs permitted)
Camera»Pivot	CAMERA.PIVOT	-1:as-is, 0:default, n:$FMSID of object(s) to pivot around (multiple IDs permitted)
Camera»Attach	CAMERA.ATTACH	-1:as-is, 0:default, n:$FMSID of object to attach camera to
Camera»Perspective	CAMERA.PERSPECTIVE	-1:as-is, 0:orthogonal, 1:perspective
Camera»Front	CAMERA.FRONT	-1:as-is, 0:unlock, 1:lock
Camera»Back	CAMERA.BACK	-1:as-is, 0:unlock, 1:lock
Camera»Top	CAMERA.TOP	-1:as-is, 0:unlock, 1:lock
Camera»Bottom	CAMERA.BOTTOM	-1:as-is, 0:unlock, 1:lock
Camera»Left	CAMERA.LEFT	-1:as-is, 0:unlock, 1:lock
Camera»Right	CAMERA.RIGHT	-1:as-is, 0:unlock, 1:lock
Camera»Load	CAMERA.LOAD	-1:as-is, 0-9:predefined, n:$FMSCMRA return value
Show»Wireframe	WIREFRAME	-1:as-is, 0:off, 1:on
Show»Tool Path	TOOL.PATH	-1:as-is, 0:off, 1:on
Show»Tool Vector	TOOL.VECTOR	-1:as-is, 0:off, 1:on
Show»Tool Path as Overlay	TOOL.OVERLAY	-1:as-is, 0:off, 1:on
Show»Filters»Machine	FILTERS.MACHINE	-1:as-is, 0:off, 1:on
Show»Filters»Tools	FILTERS.TOOLS	-1:as-is, 0:off, 1:on
Show»Filters»Fixtures	FILTERS.FIXTURES	-1:as-is, 0:off, 1:on
Show»Filters»Stock	FILTERS.SSTOCK	-1:as-is, 0:off, 1:on
Show»Filters»Parts	FILTERS.PARTS	-1:as-is, 0:off, 1:on
Show»Filters»In-process Stock	FILTERS.ISTOCK	-1:as-is, 0:off, 1:on
Show»Filters»Stock Checkpoints	FILTERS.CHECKPOINTS	-1:as-is, 0:off, 1:on
Show»XY Plane Grid	GRID.XYPLANE	-1:as-is, 0:off, 1:on
Show»YZ Plane Grid	GRID.YZPLANE	-1:as-is, 0:off, 1:on
Show»ZX Plane Grid	GRID.ZXPLANE	-1:as-is, 0:off, 1:on
na	GRID	-1:as-is, 0:off, n:$FMSID of grid reference
Show»Axes Marker	AXES	-1:as-is, 0:off, 1:on
Show»Kinematics	KINEMATICS	-1:as-is, 0:off, 1:on
Show»Workpiece Reference	REFERENCE.WORKPIECE	-1:as-is, 0:off, 1:on
Show»Tool Reference	REFERENCE.TOOL	-1:as-is, 0:off, 1:on
Show»Safety	SAFETY	-1:as-is, 0:off, 1:on
Show»Display	DISPLAY	-1:as-is, 0:off, 1:on, or scheme name (string)
Hide	HIDE	-1:as-is, 0:hide all, n:$FMSID of object(s) to hide (multiple IDs permitted)
Show	SHOW	-1:as-is, 0:hide all, n:$FMSID of object(s) to show (multiple IDs permitted)
Options»Misc»World	BACKGROUND.TOP	-1:as-is, 0-255:RGB (3 values), or $FMSCOLR name (string)
Options»Misc»World	BACKGROUND.BOTTOM	-1:as-is, 0-255:RGB (3 values), or $FMSCOLR name (string)
Options»Misc»World	BACKGROUND	sets both TOP and BOTTOM
Options»Tool Path»Trace	TOOL.TRACE	-1:as-is, 0:Tool tip, 1:SCP
Options»Tool Path»Mode	TOOL.MODE	-1:as-is, 0:off, 1:all, 2:seconds, 3:tools, 4:operations; optional 2nd parameter specifies seconds|tools|operations value (-1:as-is)

If successful, this function returns a positive numeric value identifying the camera position and state before changes were applied. This returned value can be used in place of the predefined position n in a later call to $FMSCMRA, to reset the camera position and display settings back to their original settings.

The $FMSPIC Function

Takes a picture of the simulation window Returns: Numeric

The $FMSPIC function takes a picture of the simulation window. All parameters are optional, but if specified they must be in the order shown above.

If an optional width and height are specified and both are positive values, then the image will have the specified dimensions in pixels. The simulation window will not be affected nor need it be visible when picture dimensions are specified.

An optional file parameter (string variable or constant) can be specified to override the default directory and/or file name for the resulting PNG formatted picture. If file is omitted or does not specify a directory, then pictures will be saved in the folder identified by the vm_picture_dir configuration (i.e., DEF file) variable. If this variable is not defined or is blank, then pictures will be saved in the user's “Pictures\ICAM\270” folder. If file is omitted or does not specify a file name, then pictures will be saved in “picnnn.png” files where “nnn” is a unique 3-digit value.

An optional TIME,s couplet can be specified to take a picture of the simulation at an earlier moment time (where s is measured in seconds from the start of the simulation).

An optional CAMERA parameter list can be used to temporarily set the camera and display settings to desired values before taking the picture. The original camera and display settings will be restored after the picture is taken. See the $FMSCMRA function for a list of available settings.

This function returns a value of 1 if a picture was taken; otherwise a value of 0 (zero) is returned to indicate failure.