

|
About Download Documentation Tutorials Add-Ons Specification Contact: rob (at) kickstandlabs.com |
openPipeline for Maya Procedure Documentation (Nov. 19, 2007) openPipelineUtility.mel openPipelineInit.mel openPipelineFile.mel openPipelineSceneInv.mel openPipeline.mel openPipelineUI.mel openPipelineNotes.mel openPipelineProject.mel openPipelineUtility.melopenPipelineIsValidFolderDescription: Returns whether a folder exists and doesn't have a period "." at the start of its nameInput: path - the path to be tested (string) Returns: 1 of valid, 0 if not Note: This proc was created to prevent oP from mistaking folders like ".svn" for project folders openPipelineNumWorkshopsDescription: Returns the number of workshops that exist for a shot, asset or componentInput: path - the full path of the shot, asset, component to check (string) Returns: The number of workshops (int) openPipelineGetLatestWorkshopVersionDescription: Returns the version of the latest workshop for a given asset, component or shotInput: path - the full path of the shot/asset/component to check (string) Returns: The latest workshop version number (int) openPipelineGetXmlTopDescription: Returns all the xml data which is a child to the root element specific by "$tag"Input: xml - The input xml with tags and data as separate entries in a string array (string array) tag - the root element tag in the xml file (string) Returns: A string array with each entry holding either an xml tag or data openPipelineComponentHasMasterDescription: Checks if a given component has been masteredInput: path - the full path of the component to check (string) Returns: 0 if no master exists, non-zero integer otherwise. openPipelineGetXmlAllDescription: Parses an xml file and returns each tag and entry as a separate array entryInput: xmlFile - the file to be evaluated (string) Returns: A string array with each entry holding either an xml tag or data openPipelineNumVersionsDescription: Returns the number of old mastered versions that exist for a shot, asset or componentInput: path - the full path of the shot, asset, component to check (string) Returns: The number of versions (int) openPipelineGetLibFilesDescription: Returns all maya files in the asset library of the current projectInput: none Returns: string array of filenames with full paths Note: This procedure is only used by the "openPipelineUtilityUpdatePadding" proc openPipelinePadDescription: Returns a non-negative integer as a string with paddingInput: num - input integer (int) padding - the padding to apply (int) Returns: The number as a padded string (an input of 12 and 4 yields "0012") Note: If the padding specified doesn't exceed the number of digits in the number, no leading zeroes are addded openPipelineGetDateDescription: Returns the current dateInput: none Returns: The current date in the format MM/DD/YY (string) openPipelineGetFolderFromPathDescription: Returns the folder name at a given depth of a pathInput: path - the full path (string) offsetFromLast - the depth of the folder, counting backwards from the deepest (string) Returns: The name of the folder Note: passing in 0 as the second parameter has the same function as the "basename" mel command openPipelineAssetHasWorkshopDescription: Checks if a given asset has at least one workshopInput: path - the full path of the asset to check (string) Returns: 0 if no workshops exist, non-zero integer otherwise. openPipelineIsXmlOutTagDescription: XML toolInput: xml - xml data (string) tag - the tag to be searched for (string) Returns: 1 if the string is the correct closing tag, 0 if not openPipelineUtilityUpdatePaddingDescription: Updates filename padding for users upgrading from version 0.3 or belowInput: none Returns: none openPipelineIsXmlInTagDescription: Checks if a string is a specific opening xml tagInput: xml - the string to be evaluated (string) tag - the name of the tag being tested (string) Returns: 1 if the string is the correct opening tag, 0 if not openPipelineGetVersionsDescription: Returns all of the version files for a given asset, component or shotInput: path - the full path of the shot, asset, component to check (string) Returns: A string array of the full paths to the version files openPipelineComponentHasWorkshopDescription: Checks if a given component has at least one workshopInput: path - the full path of the component to check (string) Returns: 0 if no workshops exist, non-zero integer otherwise. openPipelineGetVersionFromFileDescription: Returns the version of an ma or mb file, assuming a padding of 4Input: file - the filename (string) Returns: The version of the file (int) Note: This proc is designed to work with files that adhere to the numbering convention of openPipeline (e.g. "filename0034.mb") openPipelineUnpadDescription: Returns an integer from a padded string representation of a numberInput: numString - string to be "unpadded" Returns: The number as an integer (an input of "00304" yields the integer 304) openPipelineAssetHasMasterDescription: Checks if a given asset has been masteredInput: path - the full path of the asset to check (string) Returns: 0 if no master exists, non-zero integer otherwise. openPipelineGetShotFilesDescription: Returns all maya files in the shot library of the current projectInput: none Returns: string array of filenames with full paths Note: This procedure is only used by the "openPipelineUtilityUpdatePadding" proc openPipelineGetXmlDataDescription: XML tool - returns the data encapsulated by the opening and closing tags of an xml elementInput: xml - xml data (string) tag - the tag to be searched for (string) Returns: The data found (string) openPipelineGetXmlSecondaryDescription: XML toolInput: xml - xml data (string array) tag - the tag to be searched for (string) Returns: 1 if the string is the correct closing tag, 0 if not openPipelineGetWorkshopsDescription: Returns all of the workshop files for a given asset, component or shotInput: path - the full path of the shot, asset, component to check (string) Returns: A string array of the full paths to the workshop files openPipelineGetTimeDescription: Returns the current timeInput: none Returns: The current time (string) openPipelineUtilityUpdateSceneStructureDescription: Updates the folder structure when updating from an oP version without Shot->Sequence functionalityInput: none Returns: none openPipelineShotHasMasterDescription: Checks if a given shot has been masteredInput: path - the full path of the shot to check (string) Returns: 0 if no master exists, non-zero integer otherwise. openPipelineGetLatestMasterVersionDescription: Returns the version of the most recent previously mastered version for a given asset, component or shotInput: path - the full path of the shot, asset, component to check (string) Returns: The latest master version number (int) openPipelineGetNotePathDescription: Returns a note file for the asset/component/scene specified by "$inputMode" (see below)Input: inputMode - 'note' (currently selected), 'openednote'(currently open) or 'newnote' (newly created) (string) Returns: The full path and filename for the appropriate note file (string) back to top openPipelineInit.melback to top openPipelineFile.melopenPipelineImportRefsDescription: Flattens the scene by importing all the referenced filesInput: none Returns: none openPipelineShotAssetActionDescription: Performs an action on the Asset currently selected in "Available Assets" in the Shot Management tab (import, or reference)Input: action - action to perform ('reference' or 'import') (string) Returns: 1 if successful, 0 if not Notes: The Action is always performed on the latest mastered version of the Asset openPipelineNewAssetProcessDescription: Creates a new Asset under the currently selected Asset TypeInput: name - the name of the new Asset (string) Returns: none openPipelineRemoveFolderDescription: Moves the files and folders under the selected item to the "deleted" folderInput: category - the category of the item to be deleted: ('type', 'asset', 'component', 'sequence', 'shot', 'shotComponent') (string) Returns: none openPipelineNewSequenceProcessDescription: Creates a new Sequence under the currently selected projectInput: name - the name of the new Sequence (string) Returns: none openPipelineArchiveFolderDescription: Moves the files and folders under the selected item to the archiveInput: path - path of asset/component/shot (string) Returns: none openPipelineShotActionDescription: Performs an action on a Shot (open, import, or reference)Input: type - 'master' or 'workshop' (string), versionOffset - for opening previous workshop versions. 0 means latest version (int), action - action to perform ('open', 'import', or 'reference') (string), currentlyOpen - 1 to perform action on currently open Shot, 0 for currently selected Shot (int) Returns: 1 if successful, 0 if not openPipelineSaveMasterDescription: Saves a master for the currently open asset/component/shot/shot componentInput: none Returns: none openPipelineSaveWorkshopDescription: Saves a workshop for the currently open asset / component / shot / shot componentInput: none Returns: none openPipelineNewShotComponentProcessDescription: Creates a new Shot Component under the currently selected ShotInput: name - the name of the new Component (string) Returns: none openPipelineCleanMasterDescription: Performs optional clean-up steps prior to mastering (flattens references, removes display layers)Input: none Returns: none openPipelineNewComponentProcessDescription: Creates a new Component under the currently selected AssetInput: name - the name of the new Component (string) Returns: none openPipelineNewAssetTypeProcessDescription: Creates a new Asset Type under the currently selected projectInput: name - the name of the new Asset Type (string) Returns: none openPipelineAssetActionDescription: Performs an action on an Asset (open, import, or reference)Input: type - 'master' or 'workshop' (string), versionOffset - for opening previous workshop versions. 0 means latest version (int), action - action to perform ('open', 'import', or 'reference') (string), currentlyOpen - 1 to perform action on currently open Asset, 0 for currently selected Asset (int) Returns: 1 if successful, 0 if not openPipelineNewShotProcessDescription: Creates a new Asset Shot under the currently selected SequenceInput: name - the name of the new Asset Type (string) Returns: none openPipelineProcessSaveDescription: Saves the currently open Asset, Component, Shot or Shot ComponentInput: saveType - 'workshop' or 'master' (string) Returns: none Notes: this procedure will: -call "openPipelineSaveWorkshop" and/or "openPipelineSaveMaster" for actual file operations -call "openPipelineAssetNoteWriter" for updating the appropriate note file -call "openPipelineLoadCurrentAssetNote" for displaying the updated notes -call "openPipeline____Action" to open the file which was just saved openPipelineRetrieveFolderDescription: Moves files and folders back from the archiveInput: path - path of asset/component/shot (string) Returns: none openPipelineShotComponentActionDescription: Performs an action on a Shot Component(open, import, or reference)Input: type - 'master' or 'workshop' (string), versionOffset - for opening previous workshop versions. 0 means latest version (int), action - action to perform ('open', 'import', or 'reference') (string), currentlyOpen - 1 to perform action on currently open Shot Component, 0 for currently selected Shot Component (int) Returns: 1 if successful, 0 if not openPipelineComponentActionDescription: Performs an action on a Component (open, import, or reference)Input: type - 'master' or 'workshop' (string), versionOffset - for opening previous workshop versions. 0 means latest version (int), action - action to perform ('open', 'import', or 'reference') (string), currentlyOpen - 1 to perform action on currently open Component, 0 for currently selected Component (int) Returns: 1 if successful, 0 if not back to top openPipelineSceneInv.melback to top openPipeline.melsourceModuleDescription: Finds all the mel files in a path (and potentially subpath) and sources themInput: path - The path to look in (string) Returns: none openPipelineSetProjPathFieldDescription: Sets the text for the script path text fieldInput: path - The path to set the field to (string) type - Not used (string) Returns: none Note: Called directly by the browse file dialog openPipelineSetupExecDescription: Sets up the Project File Path and the Script Path depending on user inputThis method checks the user's input for validity and then edits the 'openPipeline.mel' script to reflect the changes to global variables $openPipeline_projectFilePath and $openPipeline_scriptPath Input: none Returns: none openPipelineSetMainPathDescription: Sets the text for the project file path text fieldInput: path - The path to set the field to (string) type - Not used (string) Returns: none Note: Called directly by the browse file dialog openPipelineIsValidScriptPathDescription: Checks if the given folder is a valid script patha valid script path contains the file 'openPipeline.mel' and contains a folder name 'openPipeline' Input: folder - The path to be checked (string) Returns: 1 if path is a valid script path, 0 if not (int) openPipelineDescription: Main openPipeline procedureInput: none Returns: none openPipelineSetupDescription: Creates the openPipeline Setup UIInput: none Returns: none openPipelineIsValidProjFilePathDescription: Checks if the given folder is a valid project pathThe path needs to be an existing path. Input: folder - The path to be checked (string) Returns: 1 if path is valid, 0 if not (int) openPipelineProjPathFieldToggleDescription: Toggles the text field for setting the project file path between Default and CustomInput: none Returns: none openPipelineIsEditableFileDescription: Checks of the given file is readable and writeableThis is used to check if the openPipeline.mel file can be read and edited. Input: filename - Full path to the file to be checked (string) Returns: 1 if file is readable and writeable, 0 if not (int) back to top openPipelineUI.melopenPipelineUpdateAssetMenusDescription: Updates the Pop-up menus of the Asset listInput: assetPath - the path of the currently selected Asset (string) Returns: none openPipelineAssetInformationDescription: Updates the Description box in the Asset Management tabInput: none Returns: none openPipelineGetSelectedComponentDescription: Returns the currently selected ComponentInput: none Returns: A full path to the Component selected. An empty string is returned if none is selected. (string) openPipelineClearAssetInfoDescription: Clears the description of the currently selected Asset or ComponentInput: none Returns: none openPipelineUpdateShotAssetTypeListDescription: Updates list of asset types in the "Available Assets" section of the Shot Management TabInput: none Returns: none openPipelineGetSelectedSequenceDescription: Returns the currently selected SequenceInput: none Returns: A full path to the Sequence selected. An empty string is returned if none is selected. (string) openPipelineGetSelectedShotAssetTypesDescription: Returns the Asset selected under the Available Assets list of the Shot Management tabInput: none Returns: A string representing the full path to the Asset selected. Empty string is returned if no Asset is selected. openPipelineReviveWorkshopCallbackDescription: Reads the user input from the Revive window and calls the appropriate file operation to revive an old Workshop.Input: none Returns: none openPipelineSaveMasterFileGUIDescription: Launches the UI for MasteringInput: none Returns: none openPipelineUpdateAssetTypeListDescription: Updates the list of Asset Types in the UIInput: none Returns: none openPipelineHelpLaunchDescription: Launches the online Help for oPInput: none Returns: none openPipelineClearShotInfoDescription: Clears the description of the currently selected Shot or Shot ComponentInput: none Returns: none openPipelineProjSelectedDescription: This proc is run whenever a new Project is selected. In turn, it updates all UI elements below the project level.Input: none Returns: none openPipelineUpdateSequenceListDescription: Updates the list of Sequences in the UIInput: none Returns: none openPipelineGetSelectedShotComponentDescription: Returns the currently selected Shot ComponentInput: none Returns: A full path to the Shot Component selected. An empty string is returned if none is selected. (string) openPipelineComponentSelectedDescription: This proc is called whenever a Component is selected. It updates all the UI affected by what Component is currently selected.Input: preserveSelection - none Returns: none openPipelineUpdateShotMenusDescription: Updates the Pop-up menus of the Shot listInput: shotPath - the path of the currently selected Shot (string) Returns: none openPipelineRemoveSecondaryWindowsDescription: Closes secondary oP windowsInput: none Returns: none openPipelineNewAssetUIDescription: Launches the UI for creating a new AssetInput: none Returns: none openPipelineGetSelectedAssetDescription: Returns the currently selected AssetInput: none Returns: A full path to the Asset selected. An empty string is returned if none is selected. (string) openPipelineShotAssetTypeSelectedDescription: This proc is called whenever an Asset Type is selected from the Available Assets section of the Shot Managment Tab.Input: none Returns: none openPipelineShotSelectedDescription: This proc is called whenever a Shot is selected in the UI. In turn, it updates all the UI elements affected by what Shot is selected.Input: preserveSelection - whether currently selected items should still be selected after updating (int) Returns: none openPipelineGetSelectedShotDescription: Returns the currently selected ShotInput: none Returns: A full path to the Shot selected. An empty string is returned if none is selected. (string) openPipelineUpdateShotListDescription: Updates list of shots in the UIInput: preserveSelection - whether the current selected item in the list should still be selected after updating (int) Returns: none openPipelineSaveWorkshopGUIDescription: Launches the UI for Saving a WorkshopInput: none Returns: none openPipelineNewAssetTypeUIDescription: Launches the UI for creating a new Asset TypeInput: none Returns: none openPipelineNewShotUIDescription: Launches the UI for creating a new ShotInput: none Returns: none openPipelineShotComponentSelectedDescription: This proc is called whenever a Shot Component is selected. It updates all the UI affected by what Shot Component is currently selected.Input: none Returns: none openPipelineAssetTypeSelectedDescription: This proc is called whenever an Asset Type is selected. It updates all the UI elements below the Asset Type level.Input: preserveSelection - whether previously selected items should still be selected after the update (int) Returns: none openPipelineCloseUIDescription: Closes all oP-related windowsInput: none Returns: none openPipelineUpdateCustomUIDescription: Updates the UI to reflect user-defined names for "workshop" and "master"Input: none Returns: none openPipelineSaveShotDescriptionDescription: Saves the user-specified description of the currently selected Shot or Shot ComponentInput: none Returns: none openPipelineUpdateComponentMenusDescription: Updates the Pop-up menus of the Component listInput: componentPath - the path of the currently selected Component (string) Returns: none openPipelineSaveAssetDescriptionDescription: Saves the user-specified description of the currently selected Asset or ComponentInput: none Returns: none openPipelineGetSelectedAssetTypesDescription: Returns the currently selected Asset TypesInput: none Returns: A string array, with each entry representing a full path to the Asset Type selected. Empty array is returned if no Asset Type is selected. openPipelineArchiveDialogDescription: Creates the Archive UIInput: type - the type of the item being archived ('asset', 'component', 'shotComponent', 'shot') (string) Returns: none openPipelineNewAssetComponentUIDescription: Launches the UI for creating a new ComponentInput: none Returns: none openPipelineNewShotComponentUIDescription: Launches the UI for creating a new Shot ComponentInput: none Returns: none openPipelineUpdateCurrentlyOpenDescription: Updates the "Currently Open" displays on both "Asset Management" and "Shot Management" tabsInput: none Returns: none openPipelineUpdateWorkingTabDescription: Updates the optionVar which keeps track of which tab is currently activeInput: none Returns: none openPipelineNewSequenceUIDescription: Launches the UI for creating a new SequenceInput: none Returns: none openPipelineAboutDialogDescription: Shows the "About" window, with information and creditsInput: none Returns: none openPipelineShotInformationDescription: Updates the Description box in the Shot Management tabInput: none Returns: none openPipelineShotAssetSelectedDescription: This proc is called whenever an Asset is selected from the Available Assets section of the Shot Managment Tab.Input: none Returns: none openPipelineAssetSelectedDescription: This proc is called whenever an Asset is selected. It updates all the UI elements below the Asset level.Input: preserveSelection - Whether previously selected items should still be selected after the update (int) Returns: none openPipelineReviveGUIDescription: Launches the UI for Reviving an old WorkshopInput: none Returns: none openPipelineUpdateShotComponentMenusDescription: Updates the Pop-up menus of the ShotComponent listInput: componentPath - the path of the currently selected Shot Component (string) Returns: none openPipelineUIDescription: Builds the main oP UIInput: none Returns: none back to top openPipelineNotes.melopenPipelineReviveWorkshopNotesCallbackDescription: Refreshes the notes in the Revive Workshop dialog depending on the version the user has selected.Input: none Returns: none openPipelineCountNotesDescription: Counts the number of note entries for a specific itemInput: inputPath - the path of the item to query Returns: The number of note entries (int) openPipelineReadAllNotesDescription: Read all notes of a specified itemInput: inputPath - The note path of the item to be queried (string) Returns: A string array with each entry representing a note openPipelineCullNotesByVersionDescription: Read all notes that match a particular versionInput: allTheNotes - All the notes to be considered (string array) version - The version to look for (int) Returns: A string array with the notes that match the given version (in XML format) Note: This proc has the same functionality as "openPipelineReadNotesByVersion" but it takes in the actual notes as an input rather than a path to the note file. openPipelineClearCurrentShotNoteDescription: Clears the "Most Recent Action" section of the Shot Management tabInput: none Returns: none openPipelineLoadAssetNoteDescription: Updates the "History" section of the Asset Management tab, depending on what item is currently selectedInput: none Returns: none openPipelineCreateDescriptionDescription: Create a description file for an itemInput: path - The path of the item for which to create the description (string) Returns: none openPipelineGetCleanLineXMLDescription: Removes the white space from a string and adds escape characters toInput: nextLine - The line to clean (string) Returns: The cleaned line as a string openPipelineGetDescriptionDescription: Gets the description for an itemInput: path - The path of the item to query (string) Returns: The description (string) openPipelineReadNotesByEventDescription: Read all notes that describe a particular eventInput: inputPath - The note path for the item to be queried (string) type - The type of event to look for (created, workshop, etc.) (string) Returns: A string array with the notes that match the given event (in XML format) openPipelineReadXMLDescription: Formats notes in XML format to be displayedInput: inputPath - the path of the notes Returns: A string array with each entry representing a Note in display format openPipelineReadLatestNoteDescription: Get the latest note for a specific asset/component/shotInput: inputPath - the path to the item (string) Returns: A string array with entry 0 containing the appropriate note openPipelineReadNotesByTypeDescription: Read all notes that match a particular typeInput: inputPath - The note path for the item to be queried (string) type - The type to look for (creation, workshop, master, etc.) (string) Returns: A string array with the notes that match the given type (in XML format) openPipelineNoteWriterDescription: Creates a new noteInput: inputMode - The mode of the note to be created (creation, missing, etc.) (string) Returns: 1 if successful (int) openPipelineClearCurrentAssetNoteDescription: Clears the "Most Recent Action" section of the Asset Management tabInput: none Returns: none openPipelineFilePermissonDescription: Change the file permission in WindowsInput: inputMode - + set, - clean, R read-Only, H hidden (string) inputPath - The path to apply the permission on (string) Returns: none openPipelineReadNotesByVersionDescription: Read all notes that match a particular versionInput: inputPath - The note path for the item to be queried (string) version - The version to look for (int) Returns: A string array with the notes that match the given version (in XML format) openPipelineFormatXMLDescription: Formats an XML note to be displayedInput: line - the note in XML(string) Returns: A string with the note in display mode openPipelineSetDescriptionDescription: Set the description of an itemInput: path - The path of the item for which to set the description (string) newDescription - The new description (string) Returns: none openPipelineReadIndividualNoteDescription: Reads an individual noteInput: inputPath - the note path of the item (string) index - the index of the individual note to return Returns: A string with the specified note openPipelineLoadCurrentShotNoteDescription: Updates the "Most Recent Action" section of the Shot Management tab, depending on what item is currently openInput: none Returns: none openPipelineLoadShotNoteDescription: Updates the "History" section of the Shot Management tab, depending on what item is currently selectedInput: none Returns: none openPipelineLoadCurrentAssetNoteDescription: Updates the "Most Recent Action" section of the Asset Management tab, depending on what item is currently openInput: none Returns: none back to top openPipelineProject.melopenPipelineSetProjDialogPathDescription: This proc is called by the file browser dialog. It sets the appropriate text field to the path the user has chosen.Input: path - the path chosen by the user (string) type - not used (string) Returns: none openPipelineEditProjectDescription: Opens the Edit Project DialogInput: none Returns: none openPipelineGetProjectListDescription: Returns the the names and paths of all existing projectsInput: none Returns: A string array with even entries containing project names and odd entries containing their corresponding paths openPipelineGetProjectsDataDescription: Returns the data for a single project in XMLInput: projName - the name of the project to query (string) Returns: A string containing the full data of a project in XML openPipelineProjDialogCallbackDescription: Performs the actions specified by the project dialog boxInput: mode - 0 for creating a new project, 1 for editing an existing project (int) editProjName - the new project name (if in edit mode) (string) Returns: none openPipelineRemoveProjectDescription: Removes the currently selected projectInput: none Returns: none openPipelineGetProjFileDescription: Returns the full path of the Project FileInput: none Returns: The full path of the Project File (string) openPipelineProjectUISelectionDescription: This proc is called whenever a project is selected in the Project UI. It queries and displays the appropriate info.Input: none Returns: none openPipelineSetProjLocationDialogPathDescription: This proc is called by the file browser dialog. It sets the appropriate text field to the path the user has chosen.Input: path - the path chosen by the user (string) type - not used (string) Returns: none openPipelineCloseProjUIDescription: Closes the Project UIInput: none Returns: none openPipelineProjectUIDescription: Opens the oP Project UIInput: none Returns: none openPipelineNewProjectDescription: Opens the New Project DialogInput: none Returns: none openPipelineProjDialogWindowDescription: Opens the Project Dialog Window. This is used either for creating a new project or editing an existing project.Input: mode - 0 for creating a new project, 1 for editing an existing project (int) Returns: none openPipelineRewriteProjFileDescription: Rewrites the project xml file with the data it is passed as a string arrayInput: A string array, with each entry containing the data of the project in an xml file Returns: none back to top This file was created by the openPipelineCreateProcDoc.py script. |