tlc_utils.common package#
Submodules#
tlc_utils.common.about module#
tlc_utils.common.miscutils module#
tlc_utils.common.naming module#
Naming conventions.
This file is part of TLC (https://github.com/jtaibo/TallerCreacionTools). Copyright (c) 2023 Universidade da Coruña Copyright (c) 2023 Javier Taibo <javier.taibo@udc.es> Copyright (c) 2023 Andres Mendez <amenrio@gmail.com>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
- tlc_utils.common.naming.DCCProjTopDirs = {'ASSETS': 'assets', 'SCENES': 'scenes', 'SOURCEIMAGES': 'sourceimages'}#
Top directories inside DCC project
- tlc_utils.common.naming.DCCSceneExtension = 'mb'#
Extension for scene (asset or shot) files
- tlc_utils.common.naming.assetTypeAbbr = {'CAMERA': 'cm', 'CHARACTER': 'ch', 'FX': 'fx', 'LIGHT': 'lg', 'PROP': 'pr', 'SET': 'st'}#
Asset type abbreviation
- tlc_utils.common.naming.assetTypeDir = {'CAMERA': '03_cameras', 'CHARACTER': '00_characters', 'FX': '05_fx', 'LIGHT': '04_lights', 'PROP': '01_props', 'SET': '02_sets'}#
Asset type directory name
- tlc_utils.common.naming.assetTypeFromAbbr(search_abbr)#
Get asset type key from abbreviation
- Parameters:
search_abbr (str) – Asset type abbreviation
- Returns:
Asset type key
- Return type:
str
- tlc_utils.common.naming.directoriesToIgnore = ['.mayaSwatches']#
Directories to ignore when analyzing project contents
- tlc_utils.common.naming.filesToIgnore = ['desktop.ini']#
Files to ignore when analyzing project contents
- tlc_utils.common.naming.imgPlanePos = {'BACK': 'imgPlaneBk', 'BOTTOM': 'imgPlaneBt', 'FRONT': 'imgPlaneFr', 'LEFT': 'imgPlaneLf', 'RIGHT': 'imgPlaneRg', 'TOP': 'imgPlaneTp'}#
Image plane positions
- tlc_utils.common.naming.libraryAssetTypeAbbr = {'CAMERA': 'lbcm', 'CHARACTER': 'lbch', 'FX': 'lbfx', 'LIGHT': 'lblg', 'PROP': 'lbpr', 'SET': 'lbst'}#
Library asset type abbreviation
- tlc_utils.common.naming.libraryAssetTypeDir = {'CAMERA': '03_lbcameras', 'CHARACTER': '00_lbcharacters', 'FX': '05_lbfx', 'LIGHT': '04_lblights', 'PROP': '01_lbprops', 'SET': '02_lbsets'}#
Library asset type directory name
- tlc_utils.common.naming.libraryAssetTypeFromAbbr(search_abbr)#
Get library asset type key from abbreviation
- Parameters:
search_abbr (str) – Asset type abbreviation
- Returns:
Asset type key
- Return type:
str
- tlc_utils.common.naming.libraryDir = '99_library'#
Library directory
- tlc_utils.common.naming.prepDptDir = {'CLOTH': '02_cloth', 'FX': '06_fx', 'HAIR': '03_hair', 'LIGHTING': '05_lighting', 'MODELING': '00_modeling', 'RIGGING': '01_rigging', 'SHADING': '04_shading'}#
Preproduction (assets) departments directory names
- tlc_utils.common.naming.prepDptKeyFromDir(search_dir)#
Get department key from directory
- Parameters:
search_dir (str) – Department directory
- Returns:
Department key
- Return type:
str
- tlc_utils.common.naming.prepDptTask = {'CLOTH': {'CLOTH': 'cloth'}, 'FX': {'FX': 'fx'}, 'HAIR': {'HAIR': 'hair'}, 'LIGHTING': {'LIGHTING': 'lgt', 'LOOKDEV': 'lkdv'}, 'MODELING': {'BLENDSHAPE': 'mbs', 'HIGHPOLY': 'mhp', 'LOWPOLY': 'mlp', 'SCULPT': 'msc'}, 'RIGGING': {'ANIM': 'anim', 'LAYOUT': 'layout', 'RIG': 'rig'}, 'SHADING': {'SHADING': 'shd'}}#
Preproduction (assets) department tasks directory names
- tlc_utils.common.naming.prepDptTaskFromAbbr(search_abbr, dpt_id)#
Get department task key from abbreviation
- Parameters:
search_abbr (str) – Department task abbreviation
dpt_id (str) – Department key
- Returns:
Department task key
- Return type:
str
- tlc_utils.common.naming.prepTaskRenamingSuggestions = {'bls': 'mbs', 'light': 'lgt', 'lighting': 'lgt', 'lights': 'lgt', 'lookdev': 'lkdv', 'mod': 'mhp', 'modbs': 'mbs', 'modhp': 'mhp', 'modlp': 'mlp', 'modsc': 'msc'}#
Suggestions to rename the task identification in files that follow older versions of the pipeline or are simply wrong (but close to the naming)
- tlc_utils.common.naming.prodDptDir = {'ANIM': '01_animation', 'CACHE': '02_cache', 'FX': '03_fx', 'LAYOUT': '00_layout', 'LIGHTING': '04_lighting', 'RENDER': '05_rendering'}#
Production (shots) departments directory names
- tlc_utils.common.naming.prodDptTask = {'ANIM': {'ABLK': 'ablk', 'ABRD': 'abrd', 'AREF': 'aref'}, 'CACHE': {'CACHE': 'cache'}, 'FX': {'FX': 'fx'}, 'LAYOUT': {'LAYOUT': 'layout'}, 'LIGHTING': {'LIGHTING': 'light'}, 'RENDER': {'RENDER': 'render'}}#
Production (shots) department tasks directory names
- tlc_utils.common.naming.srcImgDirs = {'CONCEPT': '00_conceptArt', 'TEXTURES': '01_textures'}#
Source images subdirectories for each asset
- tlc_utils.common.naming.topDirs = {'DEV': '01_dev', 'POST': '03_post', 'PRE+PROD': '02_prod', 'TRANS': '00_transDep'}#
Top directories inside project
- tlc_utils.common.naming.workingDir = '00_working'#
Working directory name for both assets and shots (prep & prod)