us.temerity.pipeline.plugin.PREnvMapAction.v2_0_0
Class PREnvMapAction

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseAction
                  us.temerity.pipeline.plugin.PREnvMapAction.v2_0_0.PREnvMapAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class PREnvMapAction
extends BaseAction

Generate optimized PhotoRealistic RenderMan latitude/longitude environment maps from source images.

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

See the RenderMan ProServer documentation for details about txmake(1).

This action defines the following single valued parameters:

Image Source

The source node which contains the images files to convert.

Image Resize

The method used to resize the input image to an exact power of two.

• Up - Resized up to the next higer power of two.
• Down - Resized down to the next lower power of two.
• Round - Resized to the nearest power of two.
• None - Image is not resized.

Texture Coords

How texture coordinates are adjusted by the resize of the input images.

• Proportional - 0 to 1 across longest dimension, 0 to aspect ratio across shortest dimensions.
• Square - 0 to 1 across both dimensions.

Filter

The filter used to downsample the source images to generate the mipmap levels.

• Box
• Triangle
• Gaussian
• Catmul-Rom
• Bessel
• Sinc

S Filter Width
T Filter Width

Overrides the width (diameter) of the downsizing filter in the S/T directions.

S Mode
T Mode

The method used to lookup texels outside the [0,1] S/T coordinate range:

• Black - Use black for all values outside [0,1] range.
• Clamp - Use border texel color for values outside [0,1] range.
• Peridoc - Tiles texture outside [0,1] range.

Filter Pattern

Controls the set of filtered texture resolutions which are generated and stored in the texture file.

• Single
• Diagonal
• All

Bit Depth

The storage size of texels in the generated texture map.

• Byte - 8-bit integer.
• Short - 16-bit integer.
• Float - 32-bit floating point.
• Lossy - compressed floating point.

Texture Format

The file format of the generated texture map.

• Pixar
• TIFF

Extra Options

Additional command-line arguments.

See Also:

Serialized Form

Field Summary

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

PREnvMapAction()

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.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

Constructor Detail

PREnvMapAction

public PREnvMapAction()

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.