TYPE: VOP
TITLE: Print VOP

This operator is used to generate a formatted text string.  It can also
output this text to the console, usually for debugging purposes.

Up to 64 inputs can be connected to this operator.  These inputs can be
integer, float, vector, vector4, matrix3, matrix, or string data.  By default,
each input value will be printed with the name of the output connected to the
input, followed by the actual value.  the values are separated by tabs.  So
connecting a vector input "P" and a float input "alpha" would result in string
that looked like this:

~c(
    P: { 0.0, 0.0, 0.0 }     alpha: 1.0
~c)

This operator can be placed anywhere in the VOP network and does not have to
be part of the node chain that ultimately connects to the "Output Variables"
operator.

Here are two examples:

To generate a more easily readable string than the default, you might set
the Format String to:

~c(
    The noise value is % with displacement %.\n The color is %.
~c)

Or, to generate the name of a texture map file based on an integer input,
you could set the Format String to:

~c(
    $HIP/map/Texture%.rat
~c)

Parameters:
    Format String          - This string specifies how the input values will
                             be formatted and displayed.  Any text can be
                             entered here.  To specify that the value from a
                             particular input should be displayed, use "%".
                             The inputs will be displayed in the order in which
                             they are connected.  To display a "%" character,
                             use "\%".  To display a "\", use "\\".  To specify
                             the start of a new line, use "\n".  A new line
                             character is automatically put at the end of the
                             string when it is output to the console.  To place
                             a TAB in the text, use "\t".  The double-quotes
                             are not actually needed anywhere in the string.
                             Any input value that does not explicitly appear in
                             the Format String is appended to the end of the
                             string using the format described above for the
                             default behavior.
    Output Text to Console - Toggle this parameter on to have the formatted
                             output string displayed in the console window.

Inputs:
    Input Number 1...N     - The input values to be put in the output string.
    Next Input             - Where the next input value should be connected.
                             Up to 64 inputs can be specified.

Outputs:
    Formatted Output Text  - The string created by formatting the input values
                             according to the details in the Format String.

See also: Inline Code(inline)
