11.4 OpenGL commands

These commands are available in OpenGL mode only.

 

ANGLE   (CHAR)Atom1   (CHAR)Atom2   (CHAR)Atom3   (INT)Flags
Measure the bond angle between three atoms.

Parameters:
Atom1    Atoms defining the bond angle. See SELECT command for the correct syntax.
Atom2
Atom3
Flags Control flags that can be combined through the "or" operator (or addition):
   
Flag Value Description
MEAS_3DOBJ 1 Show the measure indicator in the main window.
MEAS_3DTXT 2 Show the measure value in the main window.
MEAS_CONTXT 4 Show the measure value in the console window.

Return values:
The command returns the measure value and if it fails, the error code is reported.

Example:
ANGLE    C1   C2   C3   7

See also:
DISTANCE, PLANEANG, SELECT, TORSION.


ANTIALIAS   (BOOL)Mode
Enable/disable the anti-aliased visualization.

Parameters:
Mode    1 enables the antialiasing and 0 disables it.

Return values:
Error code if it fails.

Example:
ANTIALIAS    1

See also:
DEPTHCUESMARTMOVE, mLight, mShowSettings.

 


BIODOCK   (CHAR)FileName
Use this command to start a BioDock background calculation. To check if the calculation is running, read the ISRUNNING variable.

Parameters:
FileName    the file name of the BioDock input file. The .bp extension can be omitted.

Return values:
Error code if it fails.

Example:
BIODOCK    "C:\My Documents\MyDocking.bp"

See also:
MOPAC.


COLOR   (MCHAR)Color
Change the color of the current selection.

Parameters:
Color    Color name: black, white, red, green, cyan, yellow, firebirck, magenta, pink, violet, ghostgray, gray, darkgray, orange, darkgreen, blue, darkyellow, brown, skyblue, ghostpink, ghostgreen, ghostblue, ghostyellow and sand.

Return values:
Error code if it fails.

Example:
COLOR    Blue

See also:
mColorByAtom, mColorByChain, mColorByCharge, mColorByMol, mColorByRes, mColorSel.


CONCLRHIST
Clear the command history buffer of the console.

Parameters:
None.

Return values:
Error code if it fails.

Example:
CONCLRHIST

See also:
CONCLS, CONSET, CONSAVE, CONWIN, mConsole.


CONCLS
Clear the console buffer.

Parameters:
None.

Return values:
Error code if it fails.

Example:
CONCLS

See also:
CONCLRHIST, CONSET, CONSAVE, CONWIN, mConsole.


CONSAVE   (CHAR)FileName
Save the console output in a specified text file.

Parameters:
FileName    Full path and file name of the output file.

Return values:
Error code if it fails.

Example:
CONSAVE "C:\Temp\Output.txt"

See also:
CONCLRHIST, CONCLS, CONSET, CONWIN, mConsole.


CONSET   (UINT)BufferSize   (UINT)HistorySize
Allow to set the console buffer size (in lines) and the command history size.

Parameters:
BufferSize   

Output buffer size in lines (BufferSize > 20, default 200).

HistorySize

History size in number of commands (HistorySize > 0, default 20).

Return values:
Error code if it fails.

Example:
CONSET   1000 40

See also:
CONCLRHIST, CONCLS, CONSAVE, CONWIN, mConsole.


CONWIN   (UINT)PosX   (UINT)PosY   (UINT)SizeX   (UINT)SizeY
Change the position and the size of the console window.

Parameters:
PosX   

X position.

PosY Y position.
SizeX Width.
SizeY Height.

Return values:
Error code if it fails.

Example:
CONWIN   0 0 640 300

See also:
CONCLRHIST, CONCLS, CONSAVE, CONSET, mConsole.


COPY   (MCHAR)Format
Copy the molecule into the clipboard using the specified format. To paste use the mPaste menu command. For more information click here.

Parameters:
Format    Clipborad format: VEGA (Molecular object), Bitmap, Biosym, Mol2, Mopac, PDB, PDBF, XYZ.

Return values:
Error code if it fails.

Example:
COPY   Bitmap

See also:
mCopy, mCopySpecial, mCut, mPaste.


CPKPROP   (UINT)ShpereRes   (UINT)SphereScale  (UINT)CylinderRes  (FLOAT)CylinderRad
Change the CPK visualization properties.

Parameters:
ShpereRes   

Sphere resolution (8 <= SphereRes <= 24).

SphereScale

Sphere scale (10 <= SphereScale <= 50).

CylinderRes

Cylinder resolution (5 <= CylinderRes <= 20).

CylinderRad

Cylinder radius (0.05 <= CylinderRad <= 0.5).

Return values:
Error code if it fails.

Example:
CPKPROP    12   20   10   0.10 (default settings)

See also:
LIQPROP, VDWPROP, WIREPROP, mShowSettings.


DEPTHCUE   (BOOL)Mode
Enable/disable the depth cueing.

Parameters:
Mode    If Mode is 1, the depth cue is enabled, otherwise if it's 0, the depthcue is disabled.

Return values:
Error code if it fails.

Example:
DEPTHCUE    1

See also:
ANTIALIAS, SMARTMOVE, mLight, mShowSettings.


DISTANCE   (CHAR)Atom1   (CHAR)Atom2   (INT)Flags
Measure the distance between two atoms.

Parameters:
Atom1    Atoms defining the bond. See SELECT command for the correct syntax.
Atom2
Flags Control flags that can be combined through the "or" operator (or addition):
   
Flag Value Description
MEAS_3DOBJ 1 Show the measure indicator in the main window.
MEAS_3DTXT 2 Show the measure value in the main window.
MEAS_CONTXT 4 Show the measure value in the console window.

Return values:
The command returns the measure value and if it fails, the error code is reported.

Examples:
DISTANCE    CA:ALA:25   O:ASP:42   0
DISTANCE    10   36   4

See also:
ANGLE, PLANEANG, SELECT, TORSION.


GRAPHADD    (FLOAT)XValue   (FLOAT)YValue
Add a point value in the chart.

Parameters:
XValue    X value.
YValue Y value.

Return values:
Error code if it fails.

Example:
GRAPHADD   1.5   0.25

See also:
GRAPHGET, GRAPHDELETE, GRAPHSET.


GRAPHCALC    (MCHAR)ClacType
Calculate a statistical value using the chart dataset.

Parameters:
ClacType    It's the keyword for the selection of the calculation type:
  
Keyword Description
AverageVal Average value.
MaxVal Maximum value.
MinVal Minimum value.
StdDev Standard deviation.

Return values:
This function returns the result of the requested calculation. If no data are present in the chart, the return value is zero

Example:
GRAPHCALC    StdDev

See also:
GRAPHGET, GRAPHWIN.


GRAPHCLOSE
Close the Graph Editor (GraphED) window.

Parameters:
None.

Return values:
Error code if it fails.

Example:
GRAPHCLOSE

See also:
GRAPHLOAD, GRAPHNEW, GRAPHOPEN, GRAPHSAVE, GRAPHWIN, mGraphEd.


GRAPHGET    (UINT)PointIndex
Get the point values.

Parameters:
PointIndex   

Point index (0< PointIndex < GraphPoints). To obtain the total number of points (GraphPoints), use GET or PLUGINGET commands.

Return values:
This function returns the X and Y floating point values separated by a space. If PointIndex exceeds the total number of points, no values are returned.

Example:
GRAPHGET    5

See also:
GRAPHADD, GRAPHDELETE, GRAPHSET.


GRAPHDELETE   (UINT)PointIndex
Delete a point.

Parameters:
PointIndex   

Point index (0< PointIndex < GraphPoints). To obtain the total number of points (GraphPoints), use GET or PLUGINGET commands.

Return values:
Error code if it fails.

Example:
GRAPHDELETE    3

See also:
GRAPHADD, GRAPHGET, GRAPHSET.


GRAPHLABELX   (CHAR)Label
Set the X axis label.

Parameters:
Title    X axis label.

Return values:
Error code if it fails.

Example:
GRAPHLABELX    "Time (ps)"

See also:
GRAPHLABELY, GRAPHTITLE, GRAPHWIN.


GRAPHLABELY   (CHAR)Label
Set the Y axis label.

Parameters:
Title    Y axis label.

Return values:
Error code if it fails.

Example:
GRAPHLABELY    "Energy (Kcal/mol)"

See also:
GRAPHLABELX, GRAPHTITLE, GRAPHWIN.


GRAPHLOAD    (CHAR)FileName
Load the graph data file.

Parameters:
FileName    Name of the file to load. The supported file formats are CHARMm (.ene) and comma separated value (.csv).

Return values:
Error code if it fails.

Example:
GRAPHLOAD    "MyGraph.csv"

See also:
GRAPHCLOSE, GRAPHNEW, GRAPHOPEN, GRAPHSAVE, mGraphEd.


GRAPHNEW
Clear all data in the chart.

Parameters:
None.

Return values:
Error code if it fails.

Example:
GRAPHNEW

See also:
GRAPHCLOSE, GRAPHLOAD, GRAPHOPEN, GRAPHSAVE, mGraphEd.


GRAPHOPEN    (UINT)Flags
Open the Graph Editor (GraphED) window and automatically it came the current window.

Parameters:
Flags    Control flags:
  
Flag Value Description
GRAPHOPEN_CENTER

1

Center the window in the screen.

Return values:
The ID of the window or an error code if it fails.

Example:
GRAPHOPEN    1

See also:
GRAPHCLOSE, GRAPHLOAD, GRAPHNEW, GRAPHSAVE, GRAPHSETCUR, mGraphEd.


GRAPHSAVE    (CHAR)FileName   (MCHAR)Format   (CHAR)Compression
Save the graph data into a file.

Parameters:
FileName    Chart title.
Format Output format. The supported formats are:
  
Keyword Description
CSV Comma separated values.
PLT Quanta plot.
RAW Raw float format.
Compression Compression mode (NONE, BZIP2, GZIP, POWERPACKER, ZCOMPRESS).

Return values:
Error code if it fails.

Example:
GRAPHSAVE    "C:\My Documents\Graph.csv"   CSV   NONE

See also:
GRAPHCLOSE, GRAPHLOAD, GRAPHNEW, GRAPHOPEN, mGraphEd.


GRAPHSET    (UINT)PointIndex   (FLOAT)XValue    (FLOAT)YValue
Set/change the point values. To add a new point, use GRAPHADD command.

Parameters:
PointIndex   

Point index (0< PointIndex < GraphPoints). To obtain the total number of points (GraphPoints), use GET or PLUGINGET commands.

XValue X value.
YValue Y value.

Return values:
Error code if it fails.

Example:
GRAPHSET    5   3   4.34

See also:
GRAPHADD, GRAPHDELETE, GRAPHGET.


GRAPHSETCUR    (UINT)WindowID 
Set/change the current Graph Editor window. When you use this functions, all graph commands are sent to the Graph Editor window with the specified window ID. To obtain the ID of the current window, use the GRAPHID variable.

Parameters:
WindowID    

The ID of the Graph Editor window.

Return values:
Error code if the ID is wrong or if no graph windows are opened.

Example:
GRAPHSETCUR    1

See also:
GRAPHOPEN.


GRAPHTITLE   (CHAR)Title
Change the chart title.

Parameters:
Title    Chart title.

Return values:
Error code if it fails.

Example:
GRAPHTITLE    "This is my chart"

See also:
GRAPHLABELX, GRAPHLABELY, GRAPHWIN.


GRAPHWIN   (UINT)PosX   (UINT)PosY   (UINT)SizeX   (UINT)SizeY
Change the position and the size of the Graph Editor (GraphED)  window.

Parameters:
PosX   

X position.

PosY Y position.
SizeX Width.
SizeY Height.

Return values:
Error code if it fails.

Example:
GRAPHWIN   50 50 300 300

See also:
GRAPHCALC, GRAPHLABELX, GRAPHLABELY, GRAPHTITLE, mGraphEd.


LIQPROP   (UINT)SphereRes   (UINT)CylinderRes  (FLOAT)CylinderRad
Change the liquorice visualization properties.

Parameters:
SphereRes    Sphere resolution (8 <= SphereRes <= 24).
CylinderRes Cylinder resolution (5 <= CylinderRes <= 20).
CylinderRad Cylinder radius (0.05 <= CylinderRad <= 0.5).

Return values:
Error code if it fails.

Example:
LIQPROP    12   10   0.20 (default settings)

See also:
CPKPROP, VDWPROP, WIREPROP, mShowSettings.


MAINWIN   (UINT)PosX   (UINT)PosY   (UINT)SizeX   (UINT)SizeY
Change the position and the size of the main window.

Parameters:
PosX   

X position.

PosY Y position
SizeX Width.
SizeY Height.

Return values:
Error code if it fails.

Example:
MAINWIN   0 0 500 300

See also:
None.


MOPAC   (CHAR)FileName   (CHAR)Keywords
Use this command to start a Mopac background calculation. To check if the calculation is running, read the ISRUNNING variable.

Parameters:
FileName    It's the full path file name of the input file that VEGA creates to start Mopac (the .dat extension is optional).
Keywords Mopac keywords. If the CHARGE keyword isn't specified, VEGA calculates automatically the total charge and it adds this for you.

Return values:
Error code if it fails.

Example:
MOPAC "C:\Molecules\a3" "AM1 CHARGE=0 PRECISE"

See also:
mCalcMoPac.


PLANEANG   (CHAR)Atom1   (CHAR)Atom2   (CHAR)Atom3   (CHAR)Atom4   (CHAR)Atom5   (CHAR)Atom6   (INT)Flags
Measure the angle between two plane defined by two triplets of atoms.

Parameters:
Atom1    Atoms defining the first plane. See SELECT command for the correct syntax.
Atom2
Atom3
Atom4 Atoms defining the second plane.
Atom5
Atom6
Flags Control flags that can be combined through the "or" operator (or addition):
   
Flag Value Description
MEAS_3DOBJ 1 Show the measure indicator in the main window.
MEAS_3DTXT 2 Show the measure value in the main window.
MEAS_CONTXT 4 Show the measure value in the console window.

Return values:
The command returns the measure value and if it fails, the error code is reported.

Example:
PLANEANG    C1   C3   C5   C29   C31   C33

See also:
ANGLE, DISTANCE, SELECT, TORSION.


PLUGINABOUT   (CHAR)PluginName
Show the about information of the specified plugin.

Parameters:
PluginName    Name of the plugin.

Return values:
Error code if it fails.

Example:
PLUGINABOUT    PowerNet

See also:
PLUGINCONFIG, PLUGINCALL, PLUGINGET, PLUGINHELP.


PLUGINCALL  (CHAR)PluginName    (UINT)FunctionNumber
Call a plugin user function by function number.

Parameters:
PluginName    Name of the plugin.
FunctionNumber Function number (from 1 to 100).

Return values:
Error code if it fails.

Example:
PLUGINCALL    PowerNet   1

See also:
PLUGINABOUT, PLUGINCONFIG, PLUGINGET, PLUGINHELP.


PLUGINCONFIG   (CHAR)PluginName
This command opens the plugin configuration dialog.

Parameters:
PluginName    Name of the plugin.

Return values:
Error code if it fails.

Example:
PLUGINCONFIG    PowerNet

See also:
PLUGINABOUT, PLUGINCALL, PLUGINGET, PLUGINHELP.


PLUGINGET   (CHAR)Variable
As the standard GET command, it returns the value of a specific internal variable, but without using the inter-process communication system (e.g. clipboard). It's strongly recommended to use in the plugin code. For more information see the GET command.

Parameters:
Variable    Variable name..

Return values:
The value of the specified variable.

Example:
PLUGINGET   CURLANG

See also:
GET.


PLUGINHELP   (CHAR)PluginName
Show the plugin help.

Parameters:
PluginName    Name of the plugin.

Return values:
Error code if it fails.

Example:
PLUGINHELP    PowerNet

See also:
PLUGINABOUT, PLUGINCALL, PLUGINCONFIG, PLUGINGET.


REFRESH
Force the main window refresh.

Parameters:
None.

Return values:
Error code if it fails.

Example:
RERESH

See also:
None.


ROTATE   (FLOAT)X    (FLOAT)Y   (FLOAT)Z
Rotate the active object around X, Y and Z axis.

Parameters:
X    X rotation (degree).
Y Y rotation (degree).
Z Z rotation (degree).

Return values:
Error code if it fails.

Example:
ROTATE   90   45.5   0

See also:
TRANSLATE, ZOOM.


SAVEIMG   (CHAR)FileName
Save the current view as bitmap file.

Parameters:
FileName    The name name of the output bitmap. Choose the appropriate extension to select the file format, according to OpenIL/DevIL specifications.
   
Extension Format
.bmp Windows Bitmap
.gif Compuserve GIF
.jpg JPEG
.oil OpenIL
.pcx ZSoft PCX
.pnm PNM
.raw Raw data
.sgi Silicon Graphics
.tga Targa
.tif Tiff

Return values:
Error code if it fails.

Example:
SAVEIMG   "C:\SnapShot.gif"

See also:
SAVE.


SELECT   (CHAR)Selection
With this command it's possible to show/hide (see UNSELECT command) the atoms.

Parameters:
Selection    The selection uses the following format:

ATOM_NAME:RESIDUE_NAME:RESIDUE_NUMBER:CHAIN_ID:MOLECULE_MUMBER

Each argument of the selection is optional and the maximum length of each field is four characters for the ATOM_NAME, RESIDUE_NAME, RESIDUE_NUMBER, MOLECULE_MUMBER and one character for the CHAIN_ID. The selection is case-sensitive and you can use wildcards (?, *). The SELECT command can be used also to select by atom number.

Return values:
Error code if it fails.

Examples:

SELECT    H*    -> Select all hydrogens
SELECT    C*:ALA    -> Select all carbons of all alanines
SELECT    CA:*:*:B    -> Select all alpha carbon of the chain B
SELECT    *:VAL:?    -> Select all valines in the first 9 residues
SELECT    10    -> Select the atom number 10

See also:
SELRANGE, UNSELECT, UNSELRANGE, mSelectAll, mSelectCustom, mSelectNone, mSelectInvert, mSelectBackbone, mSelectNoHyd, mSelectNoWater.


SELRANGE   (MCHAR)Mode    (UINT)Start   (UINT)End
Allows to show/hide (see UNSELECTRANGE) an atom or residue range specifying the starting and the ending atom/residue number.

Parameters:
Mode    Selection mode (ATOM, RESIDUE).
Start Staring atom/residue number.
End Endig atom/residue number.

Return values:
Error code if it fails.

Examples:

SELRANGE    ATOM   45   101    -> Show atoms from 45 to 101
SELRANGE    RESIDUE   70   75    -> Show residue from 70 to 75

See also:
SELECT, UNSELECT, UNSELRANGE, mSelectAll, mSelectCustom, mSelectNone, mSelectInvert, mSelectBackbone, mSelectNoHyd, mSelectNoWater.


SMARTMOVE   (BOOL)Mode
Enable/disable the SmartMove operation (see View settings).

Parameters:
Mode    If true (1), it enables the SmartMove, otherwise if false (0), it disables it. 

Return values:
Error code if it fails.

Example:
SMARTMOVE   0

See also:
ANTIALIAS, DEPTHCUE, SMARTMOVEATM, mLight, mShowSettings.


SMARTMOVEATM   (UINT)Atoms
Change the atom threshold to auto enable the SmartMove (see View settings).

Parameters:
Atoms    Number of atoms. If it's null (0), the SmartMove is always active.

Return values:
Error code if it fails.

Example:
SMARTMOVEATM   700

See also:
ANTIALIAS, DEPTHCUE, SMARTMOVE, mLight, mShowSettings.


SRFCOLOR   (UINT)Color
Change the surface color using the RGB format.

Parameters:
Color    Color in RGB format (0 <= Color <= 16777215).

Return values:
Error code if it fails.

Example:
SRFCOLOR   255

See also:
SRFCOLORBY, mSrfColor.


SRFCOLORBY   (MCHAR)Method
This command colors the surface by a specific method.

Parameters:
Method    Coloring method (ATOM or PROPERTY).

Return values:
Error code if it fails.

Example:
SRFCOLOR   PROPERTY

See also:
SRFCOLOR, mSrfColor.


TORSION   (CHAR)Atom1   (CHAR)Atom2   (CHAR)Atom3   (CHAR)Atom4   (INT)Flags
Measure the torsion angle defined by four atoms.

Parameters:
Atom1    Atoms defining the torsion. See SELECT command for the correct syntax.
Atom2
Atom3
Atom4
Flags Control flags that can be combined through the "or" operator (or addition):
   
Flag Value Description
MEAS_3DOBJ 1 Show the measure indicator in the main window.
MEAS_3DTXT 2 Show the measure value in the main window.
MEAS_CONTXT 4 Show the measure value in the console window.

Return values:
The command returns the measure value and if it fails, the error code is reported.

Example:
TORSION    1   2   3   4

See also:
ANGLE, DISTANCE, SELECT, PLANEANG.


TRANSLATE   (FLOAT)X    (FLOAT)Y   (FLOAT)Z
Translate the active object along X, Y and Z axis.

Parameters:
X    X translation.
Y Y translation.
Z Z translation.

Return values:
Error code if it fails.

Example:
TRANSLATE   90   45.5   0

See also:
ROTATE, ZOOM.


TRJANIMPLAY
Start the trajectory animation playback.

Parameters:
None.

Return values:
Error code if it fails.

Example:
TRJANIMPLAY

See also:
OPEN, TRJANIMSET, TRJANIMSPEED, TRJANIMSTOP, TRJOPEN, TRJSEL, TRJSELFIRST, TRJSELLAST, mOpen, mAnalysis.


TRJANIMSET   (UINT)Start    (UINT)End   (BOOL)Loop
Set the animation range.

Parameters:
Start    Starting frame.
End Ending frame.
Loop If it's 1 (true), the animation is played endlessly, otherwise if it's 0 (false), the animation is played only once.

Return values:
Error code if it fails.

Example:
TRJANIMSET   12   40   1

See also:
OPEN, TRJANIMPLAY, TRJANIMSPEED, TRJANIMSTOP, TRJOPEN, TRJSEL, TRJSELFIRST, TRJSELLAST, mOpen, mAnalysis.


TRJANIMSPEED   (UINT)Speed    (UINT)Skip
Set the trajectory animation speed and the number of frames to skip for each animation step.

Parameters:
Speed    Animation speed (0 <= Speed <= 500).
Skip Number of frames to skip for each animation step (Skip >= 0).

Return values:
Error code if it fails.

Example:
TRJANIMSPEED   200   0

See also:
OPEN, TRJANIMPLAY, TRJANIMSET, TRJANIMSTOP, TRJOPEN, TRJSEL, TRJSELFIRST, TRJSELLAST, mOpen, mAnalysis.


TRJANIMSTOP
Stop the animation playback.

Parameters:
None.

Return values:
Error code if it fails.

Example:
TRJANIMSTOP

See also:
OPEN, TRJANIMPLAY, TRJANIMSET, TRJANIMSPEED, TRJOPEN, TRJSEL, TRJSELFIRST, TRJSELLAST, mOpen, mAnalysis.


TRJGRAPHENE
Show the energy data in the Graph Editor if the energy values match the trajectory file.

Parameters:
None.

Return values:
Error code if it fails.

Example:
TRJGRAPHENE

See also:
OPEN, GRAPHCLOSE, TRJOPEN, mOpen, mAnalysis.


UNSELECT   (CHAR)Selection
See SELECT command.


UNSELRANGE   (MCHAR)Mode    (UINT)Start   (UINT)End
See SELECTRANGE command.


VDWPROP   (UINT)SphereRes    (UINT)DotSize
Change the VDW visualization properties.

Parameters:
SphereRes    Sphere resolution (8 <= SphereRes <= 24).
DotSize Dot size (1 <= DotSize <= 4).

Return values:
Error code if it fails.

Example:
VDWPROP   20   2

See also:
CPKPROP, LIQPROP, WIREPROP, mShowSettings.


WIREPROP   (UINT)Thickness    (BOOL)SmoothMode
Change the wire frame visualization properties.

Parameters:
Thickness    Line thickness (1 <=  Thickness <= 5).
SmoothMode Line color smoothing (1 = enabled, 0 = disabled).

Return values:
Error code if it fails.

Example:
WIREPROP   2   0

See also:
CPKPROP, LIQPROP, VDWPROP, mShowSettings.


WKSCHANGE   (UINT)WorkspaceNumber 
Change the current workspace.

Parameters:
WorkspaceNumber   

Workspace number. It must be grater or equal to 0 and 0 is the main workspace.

Return values:
True (1) if the workspace is correctly changed or false (0) if the specified workspace doesn't exist.

Example:
WKSCHANGE   3

See also:
WKSLOCK, WKSNEW, WKSNEXT, WKSPREV, WKSREM, WKSREMALL, WKSREMCUR, WKSSETNAME, WKSUNLOCK
.


WKSLOCK
Lock the current workspace. Until the workspace is locked, it can't be changed.

Parameters
None.

Return values:
Error code if it fails.

Example:
WKSLOCK 

See also:
WKSCHANGE, WKSNEW, WKSNEXT, WKSPREV, WKSREM, WKSREMALL, WKSREMCUR, WKSSETNAME, WKSUNLOCK
.


WKSNEW
Create a new workspace and change the current to it.

Parameters
None.

Return values:
Error code if it fails.

Example:
WKSNEW 

See also:
WKSCHANGE, WKSLOCK, WKSNEXT, WKSPREV, WKSREM, WKSREMALL, WKSREMCUR, WKSSETNAME, WKSUNLOCK
.


WKSNEXT
Select the next workspace.

Parameters
None.

Return values:
True (1) if the workspace is correctly changed or false (0) if the current workspace is the last and there aren't other workspaces.

Example:
WKSNEXT 

See also:
WKSCHANGE, WKSLOCK, WKSNEW, WKSPREV, WKSREM, WKSREMALL, WKSREMCUR, WKSSETNAME, WKSUNLOCK
.


WKSPREV
Select the previous workspace.

Parameters
None.

Return values:
True (1) if the workspace is correctly changed or false (0) if the current workspace is the first (main).

Example:
WKSPREV 

See also:
WKSCHANGE, WKSLOCK, WKSNEW, WKSNEXT, WKSREM, WKSREMALL, WKSREMCUR, WKSSETNAME, WKSUNLOCK
.


WKSREM   (UINT)WorkspaceNumber   (BOOL)Ask
Remove the selected workspace. All contained data are lost.

Parameters:
WorkspaceNumber   

Workspace number. It must be grater to 0. The main workspace (0) can't be removed.

Ask

If it's true (1) and if the workspace isn't empty, a requester is showed to confirm the operation. If it's false (0), the requester isn't showed.

Return values:
True (1) if the workspace is removed without errors or false (0) if the specified workspace doesn't exist, if it's the main workspace (0) or if the user aborts the operation with the requester.

Example:
WKSREM   2   1

See also:
WKSCHANGE, WKSLOCK, WKSNEW, WKSNEXT, WKSPREV, WKSREMALL, WKSREMCUR, WKSSETNAME, WKSUNLOCK.


WKSREMALL   (BOOL)Ask
Remove all workspaces deleting all contained data. The main workspace (0) remains unchanged.

Parameters:
Ask   

If it's true (1) and if the workspace isn't empty, a requester is showed to confirm the operation. If it's false (0), the requester isn't showed.

Return values:
True (1) if the workspaces are removed without errors or false (0) if the user aborts the operation with the requester.

Example:
WKSREMALL   0

See also:
WKSCHANGE, WKSLOCK, WKSNEW, WKSNEXT, WKSPREV, WKSREM, WKSREMCUR, WKSSETNAME, WKSUNLOCK.


WKSREMCUR   (BOOL)Ask
Remove the current workspace deleting all contained data. The main workspace (0) can't removed.

Parameters:
Ask   

If it's true (1) and if the workspace isn't empty, a requester is showed to confirm the operation. If it's false (0), the requester isn't showed.

Return values:
True (1) if the workspaces are removed without errors or false (0) if the user aborts the operation with the requester or if the current workspace is the main (0).

Example:
WKSREMCUR   1

See also:
WKSCHANGE, WKSLOCK, WKSNEW, WKSNEXT, WKSPREV, WKSREM, WKSREMALL, WKSSETNAME, WKSUNLOCK.


WKSSETNAME   (CHAR)NewName
Set the name of the current workspace.

Parameters:
NewName    New workspace name.

Return values:
Error code if it fails.

Example:
WKSSETNAME   "My molecule"

See also:
WKSCHANGE, WKSLOCK, WKSNEW, WKSNEXT, WKSPREV, WKSREM, WKSREMALL, WKSREMCUR, WKSUNLOCK.


WKSUNLOCK
Unlock the current workspace, allowing to change it.

Parameters
None.

Return values:
Error code if it fails.

Example:
WKSUNLOCK 

See also:
WKSCHANGE, WKSNEW, WKSNEXT, WKSPREV, WKSREM, WKSREMALL, WKSREMCUR, WKSSETNAME, WKSLOCK.


ZCLIP   (UINT)Value
This command set the Z clipping.

Parameters:
Value    Z clipping value (1 <= Value <= 300).

Return values:
Error code if it fails.

Example:
ZCLIP   200

See also:
ANTIALIAS, DEPTHCUE, mShowSettings.


ZOOM   (UINT)Factor
Set the zoom factor.

Parameters:
Factor    zoom factor (Factor > 0).

Return values:
Error code if it fails.

Example:
ZOOM   200

See also:
ROTATE, TRANSLATE, mShowSettings.


Back to the command index