Skip to content

Home

Jump to bottom
Stephane Barbin edited this page Dec 21, 2024 · 13 revisions

Quality Control Checks Documentation

qc_banner

Overview

This Quality Control (QC) Tool is designed to run a series of checks on digital assets across different departments (such as Modeling, Rigging, and Animation) within a production pipeline. It reports any issues or warnings and offers the user the option to automatically fix these issues and publish the asset.

The tool provides a user interface (UI) within Maya, making it easy for users to view failed checks, warnings, and passed checks, and to take appropriate action before asset publishing.

Main Features:

  • Department-specific Checks: Runs a variety of QC checks depending on the department (e.g., Modeling, Rigging, Animation).
  • Report Generation: Displays a report summarizing the checks.
  • Automatic Fixes: Allows users to automatically resolve issues identified during the checks.
  • Publishing: Assets can be published when all checks have passed.

Installation

To use the tool, ensure that it is integrated within Maya. The tool relies on external modules for each department's checks and imports them dynamically during runtime.

Usage

Launching the Tool

  1. Initialize the Tool:

    ● The QC tool can be initiated from Maya by loading the UI via the QCChecks class, which loads the user interface and presents available checklists.

  2. Parenting the UI:

    ● The UI is parented to Maya’s main window for a seamless user experience.

User Interface Overview

The UI consists of the following elements:

  • Department Dropdown Menu: Allows selection of departments (e.g. Modeling, Rigging, Animation).
  • A Help button on the right of the dropdown menu that brings you to the Wiki Documentation.
  • QC List Widget: Displays the list of available QC checks.
  • Run Button: Runs all checks.
  • Fix Button: Automatically fixes the selected issue.
  • Report Button: Display a page with the check's description and a report if check fails.
  • Publish Button: Publishes the asset after running and fixing the QC checks.

qc_ui

Running Checks

  1. Selecting a Department:

    ● The app will automatically choose the department according to the scene's prefix or put it to default (first in the list) if the file name does not have the proper prefix.

  2. Running the QC Checks:

    ● Click the Run button to run the checks for the chosen department.

  3. Fixing Issues:

    ● If any issues are detected, the box icon on the left of the check's name becomes red. You can then either manually correct the issue or simply click the Fix button to the right of the check's name to automatically fix the issue, in which case, the box icon on the left of the check's name becomes green. Next to the fix button is a report button, which will bring you to a page showing the check's description and a report of what exactly failed.

  4. Publishing the Asset:

    ● After running the checks and resolving the issues, the run button changes to a Publish button to save and publish the asset.

Quality Control Modules

The tool supports different checks depending on the department:

Modeling Department

  • Animated Objects Check: Verifies that no unexpected animations exist on objects within the scene.
  • Center Check: Ensures that all objects are centered correctly.
  • Freeze Transform Check: Verifies that transforms are frozen on objects where required.
  • Scene Cleanup Check: Ensures that the scene is free of unnecessary nodes or illegal elements.

Rigging Department

Animation Department

Clone this wiki locally