/**
* Construct a {@link SubProcessLight} instance which when executed will launch an editor program
* to view the given file sequence as arguments.
*
* <p>The default implementation executes the editor program obtained with {@link #getProgram
* getProgram} method under the given environment. Subclasses should override this method if more
* specialized behavior or different command line arguments are needed in order to launch the
* editor for the given file sequence.
*
* <p>
*
* @param author The name of the user owning the files.
* @param fseq The file sequence to edit.
* @param env The environment under which the editor is run.
* @param dir The working directory where the editor is run.
* @return The controlling <CODE>SubProcessLight</CODE> instance.
* @throws PipelineException If unable to launch the editor.
* @see SubProcessLight
*/
public SubProcessLight prep(String author, FileSeq fseq, Map<String, String> env, File dir)
throws PipelineException {
if (!fseq.isSingle())
throw new PipelineException(
"The " + getName() + " Editor can only edit a single file at a time!");
ArrayList<String> args = new ArrayList<String>();
args.add("-eol.mode=LF");
args.add(fseq.getPath(0).toOsString());
return new SubProcessLight(author, getName(), getProgram(), args, env, dir);
}
/**
* Construct a {@link SubProcessHeavy SubProcessHeavy} instance which when executed will fulfill
* the given action agenda.
*
* <p>
*
* @param agenda The agenda to be accomplished by the action.
* @param outFile The file to which all STDOUT output is redirected.
* @param errFile The file to which all STDERR output is redirected.
* @return 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.
*/
public SubProcessHeavy prep(ActionAgenda agenda, File outFile, File errFile)
throws PipelineException {
NodeID nodeID = agenda.getNodeID();
/* sanity checks */
Path loadScene = null;
Path saveScene = null;
boolean isAscii = false;
TreeMap<Integer, LinkedList<Path>> mel = new TreeMap<Integer, LinkedList<Path>>();
{
/* generate the filename of the Maya scene to load */
{
String sname = (String) getSingleParamValue("MayaScene");
if (sname != null) {
FileSeq fseq = agenda.getPrimarySource(sname);
if (fseq == null)
throw new PipelineException(
"Somehow the Maya Scene node ("
+ sname
+ ") was not one of the source "
+ "nodes!");
String suffix = fseq.getFilePattern().getSuffix();
if (!fseq.isSingle() || (suffix == null) || !(suffix.equals("ma") || suffix.equals("mb")))
throw new PipelineException(
"The MayaMEL Action requires that the source node specified by the Maya "
+ "Scene parameter ("
+ sname
+ ") must have a single Maya scene file as "
+ "its primary file sequence!");
NodeID snodeID = new NodeID(nodeID, sname);
loadScene =
new Path(PackageInfo.sProdPath, snodeID.getWorkingParent() + "/" + fseq.getPath(0));
}
}
/* generate the name of the Maya scene to save */
{
Boolean save = (Boolean) getSingleParamValue("SaveResult");
if ((save != null) && save) {
FileSeq fseq = agenda.getPrimaryTarget();
String suffix = fseq.getFilePattern().getSuffix();
if (!fseq.isSingle() || (suffix == null) || !(suffix.equals("ma") || suffix.equals("mb")))
throw new PipelineException(
"The MayaMEL Action requires that the primary target file sequence must "
+ "be a single Maya scene file if the Save Result parameter is set!");
isAscii = suffix.equals("ma");
saveScene =
new Path(PackageInfo.sProdPath, nodeID.getWorkingParent() + "/" + fseq.getPath(0));
}
}
/* generate the table of MEL script files to evaluate */
for (String sname : getSourceNames()) {
Integer order = (Integer) getSourceParamValue(sname, "Order");
FileSeq fseq = agenda.getPrimarySource(sname);
if (fseq == null)
throw new PipelineException(
"Somehow an per-source Order parameter exists for a node ("
+ sname
+ ") "
+ "which was not one of the source nodes!");
String suffix = fseq.getFilePattern().getSuffix();
if (!fseq.isSingle() || (suffix == null) || !suffix.equals("mel"))
throw new PipelineException(
"The MayaMEL Action requires that the source node ("
+ sname
+ ") with "
+ "per-source Order parameter must have a single MEL script file as its "
+ "primary file sequence!");
NodeID snodeID = new NodeID(nodeID, sname);
Path script =
new Path(PackageInfo.sProdPath, snodeID.getWorkingParent() + "/" + fseq.getPath(0));
LinkedList<Path> scripts = mel.get(order);
if (scripts == null) {
scripts = new LinkedList<Path>();
mel.put(order, scripts);
}
scripts.add(script);
}
}
/* create a temporary MEL script file */
File script = createTemp(agenda, 0755, "mel");
try {
FileWriter out = new FileWriter(script);
/* a workaround needed in "maya -batch" mode */
out.write("// WORK AROUNDS:\n" + "lightlink -q;\n\n");
/* rename the current scene as the output scene */
if (saveScene != null) {
out.write(
"// SCENE SETUP\n"
+ "file -rename \""
+ saveScene
+ "\";\n"
+ "file -type \""
+ (isAscii ? "mayaAscii" : "mayaBinary")
+ "\";\n\n");
}
/* evaluate the MEL scripts */
if (!mel.isEmpty()) {
out.write("// MEL SCRIPTS \n");
for (LinkedList<Path> scripts : mel.values()) {
for (Path spath : scripts) out.write("source \"" + spath + "\";\n");
}
out.write("\n");
}
/* save the file */
if (saveScene != null) out.write("// SAVE\n" + "file -save;\n");
out.close();
} catch (IOException ex) {
throw new PipelineException(
"Unable to write temporary MEL script file ("
+ script
+ ") for Job "
+ "("
+ agenda.getJobID()
+ ")!\n"
+ ex.getMessage());
}
/* create the process to run the action */
try {
ArrayList<String> args = new ArrayList<String>();
args.add("-batch");
args.add("-script");
args.add(script.getPath());
if (loadScene != null) {
args.add("-file");
args.add(loadScene.toOsString());
}
String program = "maya";
if (PackageInfo.sOsType == OsType.Windows) program = (program + ".exe");
return new SubProcessHeavy(
agenda.getNodeID().getAuthor(),
getName() + "-" + agenda.getJobID(),
program,
args,
agenda.getEnvironment(),
agenda.getWorkingDir(),
outFile,
errFile);
} catch (Exception ex) {
throw new PipelineException(
"Unable to generate the SubProcess to perform this Action!\n" + ex.getMessage());
}
}
/**
* Construct a {@link SubProcessHeavy SubProcessHeavy} instance which when executed will fulfill
* the given action agenda.
*
* <p>
*
* @param agenda The agenda to be accomplished by the action.
* @param outFile The file to which all STDOUT output is redirected.
* @param errFile The file to which all STDERR output is redirected.
* @return 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.
*/
public SubProcessHeavy prep(ActionAgenda agenda, File outFile, File errFile)
throws PipelineException {
/* model filenames */
TreeMap<String, Path> modelPaths = new TreeMap<String, Path>();
TreeMap<String, Path> animPaths = new TreeMap<String, Path>();
TreeMap<String, String> nameSpaces = new TreeMap<String, String>();
TreeMap<String, String> reverseNameSpaces = new TreeMap<String, String>();
TreeMap<String, Boolean> usesNameSpace = new TreeMap<String, Boolean>();
TreeMap<String, String> buildTypes = new TreeMap<String, String>();
for (String sname : agenda.getSourceNames()) {
if (hasSourceParams(sname)) {
FileSeq fseq = agenda.getPrimarySource(sname);
String suffix = fseq.getFilePattern().getSuffix();
if (fseq.isSingle() && (suffix != null)) {
if (suffix.equals("ma") || suffix.equals("mb")) {
Path npath = new Path(sname);
String type = getSourceStringParamValue(sname, aSceneType);
String nspace = getSourceStringParamValue(sname, aPrefixName);
if (nspace == null) {
nspace = npath.getName();
}
if (type.equals(aModel))
modelPaths.put(sname, new Path(npath.getParentPath(), fseq.getPath(0)));
else {
animPaths.put(sname, new Path(npath.getParentPath(), fseq.getPath(0)));
nspace += "_a";
}
boolean useNSpace = false;
{
Boolean tf = (Boolean) getSourceParamValue(sname, aNameSpace);
useNSpace = ((tf != null) && tf);
}
String buildType = getSourceStringParamValue(sname, aBuildType);
if (buildType == null)
throw new PipelineException(
"The value of the "
+ aBuildType
+ " source parameter for node "
+ "("
+ sname
+ ") was not set!");
buildTypes.put(sname, buildType);
nameSpaces.put(sname, nspace);
reverseNameSpaces.put(nspace, sname);
usesNameSpace.put(sname, useNSpace);
}
}
}
}
/* the target Maya scene */
Path targetScene = getMayaSceneTargetPath(agenda);
String sceneType = getMayaSceneType(agenda);
/* create a temporary MEL script file */
File script = createTemp(agenda, "mel");
try {
FileWriter out = new FileWriter(script);
/* provide parameters as MEL variables */
out.write(genFrameRangeVarsMEL());
/* rename the current scene as the output scene */
out.write(
"// SCENE SETUP\n"
+ "file -rename \""
+ targetScene
+ "\";\n"
+ "file -type \""
+ sceneType
+ "\";\n\n");
out.write(genUnitsMEL());
writeInitialMEL(agenda, out);
/* the model file reference imports */
TreeMap<String, Path> all = new TreeMap<String, Path>(modelPaths);
all.putAll(animPaths);
for (String sname : all.keySet()) {
Path mpath = all.get(sname);
String buildType = buildTypes.get(sname);
out.write(
"// MODEL: "
+ sname
+ "\n"
+ "print \""
+ buildType
+ " Model: "
+ mpath
+ "\\n\";\n"
+ "file\n");
String nspace = nameSpaces.get(sname);
boolean useNSpace = usesNameSpace.get(sname);
if (buildType.equals(aImport)) {
out.write(" -import\n");
if (useNSpace) out.write(" -namespace \"" + nspace + "\"\n");
} else if (buildType.equals(aReference)) {
out.write(" -reference\n");
if (useNSpace) out.write(" -namespace \"" + nspace + "\"\n");
else out.write(" -renamingPrefix \"" + nspace + "\"\n");
} else {
throw new PipelineException(
"Unknown value for the "
+ aBuildType
+ " source parameter for node "
+ "("
+ sname
+ ") encountered!");
}
{
String fname = mpath.getName();
if (fname.endsWith("ma")) out.write(" -type \"mayaAscii\"\n");
else if (fname.endsWith("mb")) out.write(" -type \"mayaBinary\"\n");
else
throw new PipelineException(
"Unknown Maya scene format for source file (" + mpath + ")!");
}
out.write(" -options \"v=0\"\n" + " \"$WORKING" + mpath + "\";\n\n");
}
writeModelMEL(agenda, out);
out.write(
"global proc string removePrefix(string $name)\n"
+ "{\n"
+ " string $toReturn;\n"
+ " string $buffer[];\n"
+ " tokenize($name, \"|\", $buffer);\n"
+ " string $part;\n"
+ " for ($part in $buffer) {\n"
+ " string $buffer2[];\n"
+ " tokenize($part, \":\", $buffer2);\n"
+ " if ($toReturn == \"\")\n"
+ " $toReturn += $buffer2[(size($buffer2) -1)];\n"
+ " else\n"
+ " $toReturn += \"|\" + $buffer2[(size($buffer2) -1)];\n"
+ " }\n"
+ " return $toReturn; \n"
+ "}\n");
out.write(
"global proc string addPrefix(string $name, string $prefix)\n"
+ "{\n"
+ " string $toReturn;\n"
+ " string $buffer[];\n"
+ " tokenize($name, \"|\", $buffer);\n"
+ " string $part;\n"
+ " for ($part in $buffer) {\n"
+ " if ($toReturn == \"\")\n"
+ " $toReturn += $prefix + $buffer[(size($buffer) -1)];\n"
+ " else\n"
+ " $toReturn += \"|\" + $prefix + $buffer[(size($buffer) -1)];\n"
+ " }\n"
+ " return $toReturn;\n"
+ "}\n");
for (String sname : animPaths.keySet()) {
String nspace = nameSpaces.get(sname);
String otherNspace = nspace.substring(0, nspace.length() - 2);
String modelName = reverseNameSpaces.get(otherNspace);
if (modelName != null) {
boolean useNSpace = usesNameSpace.get(sname);
boolean otherUseNSpace = usesNameSpace.get(modelName);
String buildType = buildTypes.get(sname);
String otherBuildType = buildTypes.get(modelName);
String prefix = generatePrefix(nspace, useNSpace, buildType);
String otherPrefix = generatePrefix(otherNspace, otherUseNSpace, otherBuildType);
out.write(
"{\n"
+ " string $crvPrefix = \""
+ prefix
+ "\";\n"
+ " string $objPrefix = \""
+ otherPrefix
+ "\";\n"
+ " string $obj = $crvPrefix + \"curveInfo\";\n"
+ " if (`objExists $obj`) {\n"
+ " int $size = `getAttr -s ($obj + \".cn\")`;\n"
+ " int $i = 0;\n"
+ " for ($i = 0; $i < $size; $i++) {\n"
+ " string $curve = `getAttr ($obj + \".cn[\" + $i + \"]\")`;\n"
+ " string $attr = `getAttr ($obj + \".an[\" + $i + \"]\")`;\n"
+ " $curve = addPrefixToName($crvPrefix, $curve);\n"
+ " $attr = addPrefixToName($objPrefix, $attr);\n"
+ " print(\"connectAttr -f \" + $curve + \" \" + $attr + \"\\n\");\n"
+ " connectAttr -f $curve $attr; \n"
+ " }\n"
+ " }\n"
+ " else {\n"
+ " string $curves[] = `ls -type animCurve ($crvPrefix + \"*\")`;\n"
+ " string $curve;\n"
+ " for ($curve in $curves) {\n"
+ " string $shortName = removePrefix($curve);\n"
+ " string $buffer[];\n"
+ " tokenize($shortName, \"_\", $buffer);\n"
+ " string $attr = $buffer[(size($buffer) -1)];\n"
+ " string $name = \"\";\n"
+ " int $length = (size($buffer) -1);\n"
+ " int $i;\n"
+ " for ($i = 0; $i < $length; $i++) {\n"
+ " $name += $buffer[$i];\n"
+ " if ($i != ($length - 1) )\n"
+ " $name += \"_\";\n"
+ " }\n"
+ " string $channel = addPrefix($name, $objPrefix) + \".\" + $attr;\n"
+ " print ($curve + \"\\t\" + $channel + \"\\n\");\n"
+ " if (!`getAttr -l $channel`)\n"
+ " connectAttr -f ($curve + \".output\") $channel;\n"
+ " }\n"
+ " }\n"
+ "}\n");
}
}
/* set the time options */
out.write(genPlaybackOptionsMEL());
writeAnimMEL(agenda, out);
/* save the file */
out.write(
"// SAVE\n"
+ "print \"Saving Generated Scene: "
+ targetScene
+ "\\n\";\n"
+ "file -save;\n\n");
writeFinalMEL(agenda, out);
out.close();
} catch (IOException ex) {
throw new PipelineException(
"Unable to write temporary MEL script file ("
+ script
+ ") for Job "
+ "("
+ agenda.getJobID()
+ ")!\n"
+ ex.getMessage());
}
/* create the process to run the action */
return createMayaSubProcess(null, script, true, agenda, outFile, errFile);
}