Output messages from command lists / filters. All commands work like the C printf() command, and accept the same fundamental format specifiers. All output from these messaging commands is directed to either the GUI message box or stdout on the command line.


createDialog

Syntax:

Dialog createDialog ( string title = (none) )

Create a new, temporary Dialog with titlebar text title (if provided).

For example:

Dialog ui = createDialog("Choose a Number");
ui.addIntegerSpin("chooser", "Choice", 1, 100, 1, 25);

if (!ui.show()) error("Dialog Canceled. ");
else
{
      int n = ui.asInteger("chooser");
      printf("You chose %i\n", n);
}

defaultDialog

Syntax:

Dialog defaultDialog ( string title = (none) )

Returns the default Dialog structure for this filter / script / function, setting the window titlebar text to title, if it is provided.

For example:

Dialog ui = defaultDialog();
if (!ui.show()) error("Dialog Canceled. ");

error

Syntax:

void error ( string format, ... )

Print a message to screen and immediately exit the current command structure / filter.

For example:

int err=23;
error("Filter failed badly - error = %i.\n", err);

notifies the user that something bad probably happened  and promptly exits.


printf

Syntax:

void printf ( string format, ... )

Standard printing command.

For example:

printf("Loading data...\n");

prints the string "Loading data..." to the screen.

printf("Number of atoms = %i\n", natoms);

prints the contents of the variable natoms to the screen.


showDefaultDialog

Syntax:

int showDefaultDialog ( string title = (none) )

Shows (executes) the default Dialog structure for this filter / script / function, setting the window titlebar text to title, if it is provided.

For example:

if (!showDefaultDialog()) error("Dialog Canceled. ");

verbose

Syntax:

void verbose ( string format, ... )

Prints a message, but only when verbose output is enabled (with the -v command-line switch).

For example:

verbose("Extra information for you.\n");