org.millscript.millscript.functions
Class ImageFileFunction

java.lang.Object
  org.millscript.millscript.functions.Function
      org.millscript.millscript.functions.AbstractOutputFunction
          org.millscript.millscript.functions.AbstractOutputFileFunction
              org.millscript.millscript.functions.ImageFileFunction

Direct Known Subclasses:

JPEGFileFunction, PNGFileFunction

public abstract class ImageFileFunction
extends AbstractOutputFileFunction

This class represents the parent of all image saving functions in MillScript.

Field Summary

Fields inherited from class org.millscript.millscript.functions.AbstractOutputFunction

config

Constructor Summary

protected

ImageFileFunction(Package pack, ImageRender ir) Constructs a new image file function for the specified package and image renderer.

Method Summary

void	apply(Machine mc, int nargs) Performs this function using the specified machine, with the specified number of arguments.

Methods inherited from class org.millscript.millscript.functions.AbstractOutputFileFunction

addNewPage, getDefaultExtension, newPage, newPage, newPage, toPage

Methods inherited from class org.millscript.millscript.functions.AbstractOutputFunction

getCurrentWorkingFolder, getCurrentWorkingFolderList, getWorkingFolder, makeCurrentWorkingFolder

Methods inherited from class org.millscript.millscript.functions.Function

applyUpdater, checkNargs, checkNargsGT, checkUNargs, getName, modName, reportNargsError, reportNargsGTError, setName, toString, tryClone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ImageFileFunction

protected ImageFileFunction(Package pack,
                            ImageRender ir)

Constructs a new image file function for the specified package and image renderer.

Parameters:

pack - the package this function belongs to

ir - the image renderer this image function should use to render the image

Method Detail

apply

public void apply(Machine mc,
                  int nargs)

Description copied from class: Function

Performs this function using the specified machine, with the specified number of arguments.

Specified by:

apply in class Function

Parameters:

mc - the machine to perform this function on

nargs - the number of arguments the function is being invoked with

See Also:

Function.apply(org.millscript.millscript.vm.Machine, int)