us.temerity.pipeline.plugin.MRayTextureAction.v2_2_1
Class MRayTextureAction

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseAction
                  us.temerity.pipeline.plugin.CommonActionUtils
                      us.temerity.pipeline.plugin.PythonActionUtils
                          us.temerity.pipeline.plugin.MRayTextureAction.v2_2_1.MRayTextureAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class MRayTextureAction
extends PythonActionUtils

Generates optimized Mental Ray memory mappable textures from source images.

Converts the images which make up the primary file sequence of one of the source nodes into the texture maps which make up the primary file sequence of this node.

Note that the MAP files generated by this Action are hardware specific so care needs to be taken to insure that the hosts which generate the MAP files are of the same hardware type as the hosts which will use these files. The best way of insuring this is through the use of hardware specific Selection Keys.

See the Mental Ray documentation for for details about imf_copy(1) and memory mapped texture files.

This action defines the following single valued parameters:

Image Source

The source node which contains the images files to convert.

Format

The format of texture data stored in the MAP file.

• Pyramid (mip-mapped texture)
• Flat (single texture)

Gamma

Gama correction exponent.

Filter

Overrides the default filter value.

Texel Layout

How to organize output texel data.

• Scanlines
• Tiles

Byte Order

The byte ordering of texel data in the output texture MAP file. This must match the native byte order on the rendering

• Little-Endian (x86)
• Big-Endian (others)

Extra Options

Additional command-line arguments.

By default, the "python" program is used by this action to run the "imf_copy" commands. An alternative program can be specified by setting PYTHON_BINARY in the Toolset environment to the name of the Python interpertor this Action should use. When naming an alternative Python interpretor under Windows, make sure to include the ".exe" extension in the program name.

See Also:

Serialized Form

Field Summary

static String	aByteOrder
static String	aFilter
static String	aFormat
static String	aGamma
static String	aImageSource
static String	aTexelLayout

Fields inherited from class us.temerity.pipeline.plugin.CommonActionUtils

aExtraOptions

Fields inherited from class us.temerity.pipeline.BasePlugin

pDescription

Fields inherited from class us.temerity.pipeline.PluginID

pVendor, pVersionID

Fields inherited from class us.temerity.pipeline.Named

pName

Constructor Summary

MRayTextureAction()

Method Summary

SubProcessHeavy

prep(ActionAgenda agenda, File outFile, File errFile) Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.

Methods inherited from class us.temerity.pipeline.plugin.PythonActionUtils

createPythonSubProcess, createPythonSubProcess, createPythonSubProcess, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonIndent, getPythonLaunchHeader, getPythonLaunchPipeHeader, getPythonProgram, getPythonProgram

Methods inherited from class us.temerity.pipeline.plugin.CommonActionUtils

addExtraOptionsParam, addExtraOptionsParamToLayout, createScriptSubProcess, createSubProcess, createSubProcess, createSubProcess, createSubProcess, createTempCopySubProcess, createTempScript, escPath, escPath, getExtraOptionsArgs, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePaths, getPrimarySourcePaths, getPrimarySourcePaths, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPaths, getPrimaryTargetPaths, getPrimaryTargetPaths, getSecondarySourceBooleanParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceEnumParamIndex, getSecondarySourceIntegerParamValue, getSecondarySourceIntegerParamValue, getSecondarySourceLongParamValue, getSecondarySourceLongParamValue, getSecondarySourceOptionalBooleanParamValue, getSecondarySourceStringParamValue, getSecondarySourceStringParamValue, getSingleBooleanParamValue, getSingleDoubleParamValue, getSingleDoubleParamValue, getSingleEnumParamIndex, getSingleIntegerParamValue, getSingleIntegerParamValue, getSingleLongParamValue, getSingleLongParamValue, getSingleOptionalBooleanParamValue, getSingleStringParamValue, getSingleStringParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSourceBooleanParamValue, getSourceDoubleParamValue, getSourceDoubleParamValue, getSourceEnumParamIndex, getSourceIntegerParamValue, getSourceIntegerParamValue, getSourceLongParamValue, getSourceLongParamValue, getSourceOptionalBooleanParamValue, getSourceStringParamValue, getSourceStringParamValue, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePaths

Methods inherited from class us.temerity.pipeline.BaseAction

addPreset, addPresetValues, addSingleParam, chmod, cleanupLater, clearAllLinkParams, clearLinkParams, clone, createTemp, createTemp, equals, equalSingleParams, equalSourceParams, fromGlue, getInitialSourceParams, getPluginType, getPresetChoices, getPresetValues, getSecondarySequences, getSecondarySourceNames, getSecondarySourceParam, getSecondarySourceParams, getSecondarySourceParamValue, getSingleLayout, getSingleParam, getSingleParams, getSingleParamValue, getSourceLayout, getSourceNames, getSourceParam, getSourceParams, getSourceParamValue, getTempDir, getTempPath, hasSecondarySourceParams, hasSingleParams, hasSourceParams, initSecondarySourceParams, initSourceParams, removeAllSourceParams, removeSecondarySourceParams, removeSecondarySourceParams, removeSourceParams, setSecondarySourceParamValue, setSingleLayout, setSingleParamValue, setSingleParamValues, setSourceLayout, setSourceParamValue, setSourceParamValues, supportsSourceParams, toGlue

Methods inherited from class us.temerity.pipeline.BasePlugin

addSupport, compareTo, getDescription, getFullMessage, getPluginID, getResource, getResources, getResourceSize, getSupports, isUnderDevelopment, removeSupport, setSupports, supports, toString, underDevelopment

Methods inherited from class us.temerity.pipeline.PluginID

getVendor, getVersionID

Methods inherited from class us.temerity.pipeline.Named

getName

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

aImageSource

public static final String aImageSource

See Also:

Constant Field Values

aGamma

public static final String aGamma

See Also:

Constant Field Values

aFilter

public static final String aFilter

See Also:

Constant Field Values

aFormat

public static final String aFormat

See Also:

Constant Field Values

aTexelLayout

public static final String aTexelLayout

See Also:

Constant Field Values

aByteOrder

public static final String aByteOrder

See Also:

Constant Field Values

Constructor Detail

MRayTextureAction

public MRayTextureAction()

Method Detail

prep

public SubProcessHeavy prep(ActionAgenda agenda,
                            File outFile,
                            File errFile)
                     throws PipelineException

Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.

Overrides:

prep in class BaseAction

Parameters:

agenda - The agenda to be accomplished by the action.

outFile - The file to which all STDOUT output is redirected.

errFile - The file to which all STDERR output is redirected.

Returns:

The SubProcess which will fulfill the agenda.

Throws:

PipelineException - If unable to prepare a SubProcess due to illegal, missing or imcompatable information in the action agenda or a general failure of the prep method code.