us.temerity.pipeline.plugin.PRSubSurfDiffBAction.v2_0_0
Class PRSubSurfDiffBAction

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

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class PRSubSurfDiffBAction
extends BaseAction

Generates an irradiance 3D point cloud using a scattering, absorption and index of refraction model of subsurface diffusion of existing irradiance point clouds.

All of the 3D point cloud file (.ptc) dependencies of the target image which set the Order per-source sequence parameter will be included in the generated brick map.

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

This action defines the following single valued parameters:

Scattering

RedScattering

The red reduced scattering coefficients of the material.

GreenScattering

The green reduced scattering coefficients of the material.

BlueScattering

The blue reduced scattering coefficients of the material.

Absorption

RedAbsorption

The red absorption coefficients of the material.

GreenAbsorption

The green absorption coefficients of the material.

BlueAbsorption

The blue absorption coefficients of the material.

Index Of Refraction

The index of refraction of the material.

This action defines the following per-source parameters:

Order

Each source node sequence which sets this parameter should contain 3D point cloud files. This parameter determines the order in which the input point cloud files are processed. If this parameter is not set for a source node file sequence, it will be ignored.

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

PRSubSurfDiffBAction()

Method Summary

TreeMap<String,ActionParam>	getInitialSourceParams() Get an initial set of action parameters associated with an upstream node.
SubProcessHeavy	prep(ActionAgenda agenda, File outFile, File errFile) Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.
boolean	supportsSourceParams() Does this action support per-source parameters?

Methods inherited from class us.temerity.pipeline.BaseAction

addPreset, addPresetValues, addSingleParam, chmod, cleanupLater, clearAllLinkParams, clearLinkParams, clone, createTemp, createTemp, equals, equalSingleParams, equalSourceParams, fromGlue, 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, 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

PRSubSurfDiffBAction

public PRSubSurfDiffBAction()

Method Detail

supportsSourceParams

public boolean supportsSourceParams()

Does this action support per-source parameters?

Overrides:

supportsSourceParams in class BaseAction

getInitialSourceParams

public TreeMap<String,ActionParam> getInitialSourceParams()

Get an initial set of action parameters associated with an upstream node.

Overrides:

getInitialSourceParams in class BaseAction

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.