Skip to content

QC Dev

Jump to bottom
Stephane Barbin edited this page Nov 9, 2024 · 2 revisions

 Developer Documentation for Maya Quality Check Tool

1. Introduction

This document provides a detailed overview of the Quality Check (QC) tool designed for Autodesk Maya. It covers the purpose of the tool, setup instructions, code structure, development standards, and future expansion plans to assist developers who may need to update, maintain, or extend the tool.

2. System Requirements

  • Python Version: Python 3.12

  • Operating System: Windows

  • Software Dependency: Autodesk Maya (exact version, if specific)

  • Libraries and Modules Used: Mentioning the libraries specific to Python (e.g., os, re, or any Maya-specific Python API modules). If you used any third-party libraries, list them here.

3. Installation Instructions

  • Cloning the Repository: Clone the repository from GitHub to your desired location.

  • Setting up in Maya:

    • Update the userSetup.py file, located at C:/Users/<Username>/``Documents/``maya/<version>/scripts/.

    • Change the paths in userSetup.py to point to the local installation directory where the tool's files are stored.

4. Code Structure Overview

The following files and directories form the backbone of the tool:

  • qc_checks_ui.py: Contains the User Interface definitions.

  • qc_checks_main.py: Acts as the main entry point for running the tool.

  • publishing_modules/:

    • save_increment.py: A module for managing and automating incremental saving before publishing.

  • qc_modules/:

    • modeling/:

      • modeling_animated_objects.py: Checks for any animated objects in the scene.

      • modeling_center.py: Ensures that objects are centered.

      • modeling_scene_cleanup.py: Identifies and cleans up illegal objects in the scene.

      • modeling_xform.py: Ensures object transforms (rotation, scale) are neutralized.

5. Development Standards

  • Naming Conventions: Follow the PEP 8 standards using lower_case_with_underscores.

  • DocStrings: Document functions using PEP 257 guidelines.

  • Version Control: Use Git for version control and always pull before pushing any updates to avoid conflicts.

6. Current Functionality and Future Expansion

  • Current Status: The tool is fully functional for the modeling department.

  • Future Plans: Additional modules for Modeling, Rigging and Animation departments are planned, each with specific quality checks aligned with those departments' needs.

7. Configuration (for Developers)

  • Maya Integration: Ensuring Maya can load and run the tool without additional configurations.

  • Python 3 Setup: Python 3 is required, but no other dependencies should be necessary once the tool is correctly cloned.

8. Contact Information

For further questions or contributions, developers may contact the tool creator at sbalbarbin@gmail.com.

Clone this wiki locally