The Sanity Checking Tool performs sanity checks at the modeling phase. It acts as a user interface, is very easily extensible (see Adding User Checks) and can be called programmatically through other tools (such as publishing tools) to automatically check the sanity of assets before publish.
osbTools contains MEL, Python and C++. It is also dependent on boost 1.47.0.
From Maya command line:
source "osbSanityChecker.mel";
There are various types of checks:
-
Perform: This is a one step check which performs its duties in a single click.
-
Check, Select: This type of check is for information purposes only, it will detect a defect in the and enable the user to select the problematic components.
-
Check, Select, Fix: This is a 3 step check which enables the user to run a test, select the problematic components, and fix them.
When '''edit > Run on all geo''' is checked, the checks will be run on the whole scene. When it is unchecked the checks will run on the selected geometry only.
Ticking the check-boxes to the left of the checks, then click '''edit > hide checked items''' will hide selected items from the window. This enables to only work with UV tests for example. This combined with the ability to add your own checks means users can use this as a framework to add their own checks and make the tool their own.
To unhide hidden checks, simply click '''edit > reset'''.
This check looks for open borders in polygon shells and the fix closes them. This is a default Maya test.
This check looks for open borders in polygon shells and adds an edge loop to their border.
This checks for edges whose two vertices are less than 1e-05 units apart.
Makes sure that no polygonal faces have more than 4 edges. The Fix is performed by triangulating offending faces. This is a default maya test.
Fixes non-manifold geometry, this is default maya functionality. For more information on non-manifold geometry please refer to the maya doc.
This is a default maya test. From the maya documentation:
"Lamina faces share all of their edges. When you select Lamina Faces for removal, Maya removes faces that share all edges. By removing these types of faces, you can avoid unnecessary processing time, especially when you export the model to a game console. For example, suppose you performed Edit Mesh > Duplicate Face with the Separate Duplicate Faces option turned off. You would have two faces on top of each other. If you later merge the vertices of the two faces, they would share the same edges. You can remove the extra face using Cleanup with Lamina faces turned on."
This check deletes all shaders in the scene and applies the default lambert material to all polygonal geometry
This checks whether there are any maya references left in the scene.
his check makes sure there are no more than 11 edges meeting atone single vertex.If there are more then the fix will remove every second edge.
This checks whether the normals for the object are facing 'outwards'. It uses a combination of two statistical methods to do so, and selects the method with the highest level of confidence. Please note that this check assumes that normals are conformed before running.
This check deletes history on all nodes.
This check freezes all transform nodes in the scene.
This places the top level group node's pivot at world (0,0,0). This check will not work if there is more than 1 top group transform.
This check ensures that no geometry's bounding box is below -0.005
This dialog offers renaming features for the entire hierarchy or for selection.
[[File:osbSanityInherit.png]]
This feature simply renames geometry to its immediate parents' name.
This feature is a little more complex, first of all it makes sure that every geometry name in the scene is unique. This is useful as a lot of maya scripts fail when there are more than one object having the same name. It also numbers each piece of geometry according to its position within the hierarchy.
Checking '''_GRP''' will add the '_GRP' suffix to the end of all groups.
Checking '''_PLY''' or '''_GEO''' will add either of those suffixes at the end of geo nodes. However it will only do so on geo nodes which don't currently have a suffix. If you want to override the existing suffix you'll have to first tick '''force _PLY|_GEO'''.
This check detects seams (cuts) in UVs which are not otherwise visible. For example if you select edges on a model and use the scissors tool to cut them, this is a perfect example of a seam which this check will detect.
Check that no UVs are overlapping a tile border. This is important as all the UVs per object need to fit within one grid tile.
Check no UVs/UV shells are overlapping each other. UV Shells should not overlap since they'll inherit the same texture pixels if they do. This check makes sure no shells within the same object overlap.
'''n.b.''' this check seems to currently be broken.
This checks that no UVs are facing down, to make sure textures don't show up inverted.
Make sure UVs are only in the positive areas of the UV grid.
This check deletes the defaultLightSet, the defaultObjectSet, displayLayers, defaultLayers, defaultRenderLayers, brushs ikRPsolvers, ikSCsolvers, ikSplineSolvers, DisplayLayers and RenderLayers
The sanity checker is a simple API allowing you to easily add your own checks.
You can either put your own checks in osbUserChecks.mel directly, or put them in seperate mel files and source those files from osbUserChecks.mel
Your checks should start with:
source "osbSanityCheckerAPI.mel";
The registration command is:
osbAddSanityCheck("exampleCheckName",
"Example Category Name",
"Example label - this name appears in the UI",
"Example Tooltip - this help shows up when hovering over the check in the UI",
"Perform");
The last string can either be "Perform" or "Perform,Select,fix". A "Perform" check will do all that is required in one function. For this check you'll need to declare and define a global function that has the same name as the first argument, so:
global proc exampleCheckName()
{
// checking code here
}
The function signature contains no arguments and the function has no return value. Within the function, you can assume that the correct objects that you want to check are currently selected.
The second kind of check is "Perform,Select,fix". For this type of check, the objects / components which remain selected when exampleCheckName() returns are the objects that will get added to the selection set which flags them as being problematic.
global proc exampleCheckNameFix()
{
// fixing code here
}
Once again, in this function, you can assume that the problematic objects / components that you want to fix are currently selected.
Your best option to get up to running is to take a look at existing checks inside the 'checks' directory.
If the checks that you add are used a lot please feel free to add them to the main tool and check your changes into the newton repos in bitbucket. Please also note that existing checks can be hidding by using edit > Hide selected checks, go ahead and hide checks that you do not use, and implement your own checks to make this tool your own.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent