03 Tools

Kiryha edited this page Jul 27, 2016 · 22 revisions

Animation DNA contains set of python tools for 3D and compositing branches. Tools may has small differences between JSON and FTrack versions.

Variety of pipeline actions (like save scene, export cache, assign material etc) formulated as python procedures. This procedures groped into sets related to pipeline phases and each set is a DNA tool. Below is a full list of Animation DNA tools with general tool description and explanation of each of procedure.

3D Tools | 2D Tools

Toolset for 3D branch

In Maya all DNA tools located in DNA shelf, which should appear if you will use DNA.rar and run Maya through wrapper.

ATM | ASM | SHA | ANM | EXP | IMP | FXM | RND | SNV | PUB | FTP

Attribute Manager

ATM button on DNA shelf. Attribute Manager allow to create, set and edit custom MtoA attributes on geometry shapes. Refer to a token tutorial for explanation.

Asset Manager

ASM button on DNA shelf. Modelling tool which allow to setup each asset according to pipeline requirements.
Create and set custom MtoA attributes. Add and modify render data — textures and material names. Check if asset is prepared correctly. Organize geometry to proper hierarchy. Convert geometry asset to standin asset.

  • ADD ATTR — create MtoA custom attributes (mColor, mMat, mDisp) on selected object shapes to store shading information in every asset for Arnold. Refer to a token tutorial for explanation.
  • COPY ATTR — copy MtoA attribute values onto selected objects from last selected object.
  • LINE — line up selected assets from center of scene in a row.
  • CRV — open curve editor window to modify properties of NURBs curves for Yeti.
  • SI — select instances of selected object.
  • BBOX — display selected shapes as bounding boxes.
  • DEL Z — delete GoZ attributes on selected objects.
  • MAYA SMOOTH OFF [0][1][2][3][4] — Turns off Maya smooth shape during render (when pressing 3 key), set Arnold subdivision on selected shapes from 0 to 4. Setting Arnold subdivision with [0-4] buttons also turns off Maya smooth.
  • GET COLOR —for each of selected object: copy file texture name into mColor attribute (replacing JPG extension with TX) from image file texture node of shader, assigned to each object.
  • GET DISPL — for each of selected object: copy file texture name into mDisp attribute from displacement image file texture node of shader, assigned to each object.
  • GET MATERIAL — copy name of assigned material to mMat attribute.
  • SHOW TX— read texture name from mColor attribute, create and assign lambert shader(preview shader) with this texture on of each selected object.
  • CLEAN TX — delete all preview shaders.
  • SET MATERIAL — set mMat attribute with text rom field (GEN_BASE_A)
  • SETUP STATIC — creates STATIC asset hierarchy structure for selected objects according to static asset organization rules. Select asset geo, select proxy geo, press SETUP STATIC.
  • SETUP DYNAMIC — creates DYNAMIC asset hierarchy structure for selected objects according to dynamic asset organization rules.
  • PROXY — trigger asset display between PROXY and RENDE mode. Selective sensitive. Works for all assets in scene if nothing selected, or trigger selected asset.
  • STANDIN — trigger Arnold standIn display mode between bounding box and shaded polywire. Selective sensitive. Works for all assets in scene if nothing selected, or trigger selected asset.
  • CHECK SCENE — Help to control quality of asset — analyze current scene for mistakes for and creates selection sets with problematic objects: ATTR_TRANS — consist objects with MtoA attributes on transform nodes, EMPTY_mColor — objects without data in mColor attribute, EMPTY_mMat — objects without data in mMat attribute, NO_CUSTOM_ATTR — objects without custom attributes, NO_SUBDIV — objects without Arnold subdivision values. If set SG appears — in scene exists extra shading groups, which should be deleted.
  • DEL — unlock and delete selected nodes to cleanup scenes from unnecessary data.
  • CONVERT TO STANDIN — convert static asset with geometry to static asset with standin.

Shot Assembler

SHA button on DNA shelf. Creates animation and render scenes for each shot based on information about shots and assets in FTrack, check rendering and animation scenes: if they contains all necessary assets and does this asset has proper versions, update asset versions and add missing assets, add assets, props or environment to opened scene by asset code. Creating animation scene include: save scene to proper place with proper name, setup frame range, reference RIGs of all necessary assets, create and setup camera. Creating render scene include: save scene to proper place with proper name, setup frame range, reference GEO of all necessary assets, create FUR nodes and importing all necessary material library’s(individual library for each character and proper SET for environment and assets.)

  • PART SEQ SHOT — Fields to enter part, sequence and shot to create render or animation scene.
  • CREATE RND/ANM SCENE — Creates render (animation) scene for shot noticed in PART, SEQ, SHOT fields.
  • CHECK SCENE — Check, if scene contain all necessary data: assets, props, environment. Check version of each asset. Create report in script editor.
  • FIX ALL — Add all missing assets and reload proper asset versions.
  • SNV — Save next version of current scene.
  • ADD CHARS, ADD ASSETS, ADD ENV — Add missing assets by category.
  • UPDATE SCENE REFERENCES — Reload proper asset versions.
  • ADD ASSETS — Enter names of assets you wish to reference to the current scene divided by space.
  • FOR ANM/RND — Choose RIG or GEO asset version you need to add.

Animation Manager

ANM button on DNA shelf. Animation Manager is animators tool, creates playblasts, setup camera lenses, preview object textures, analize scene content (availability and versions of characters and assets), update scenes content.

  • PLAYBLAST — creates playblast of current animation scene.
    If any playblast of this shot already exists — warning window appears, asking to choose either to overwrite existing file or save next version.
  • JPG — creates screenshot from current frame and set JPG image as thumbnail of corresponding shot in FTrack.
  • TX — show in viewport texture for selected assets.
  • [12][18][27]…[180] — set the focal length of scene camera(as well as aperture).
  • LCM — lock / unlock transform for current viewport (camera).
  • CHECK SCENE — check if scene has all assets and characters according to properties files and if versions of assets and characters are correct.
  • FIX ALL — add missing data to scene and update scene references according to shot properties files.
  • SNV — save next version of current animation scene.
  • UPDATE SCENE REFERENCES — replace assets and characters references with the versions noticed in assets properties files.
  • ADD CARS, ASSETS, ENV — add missing assets, characters or environment.
  • PUBLISH — publish version of animation scene to FTrack.

Animation Exporter

EXP button on DNA shelf. Export animation data from animation scenes through alembic cashes. Allow to work with all animation data at once, by asset types or each asset individually.

  • EXPORT ALL ANIMATION — export all animated assets and camera from current animated scene to alembic files.
  • EXPORT CAMERA — export only camera.
  • <characterNames> — export characters individually
  • EXPORT ALL CHARACTERS — export all characters.
  • <assetNames> — export assets individually.
  • EXPORT ALL ASSETS — export all assets.
  • <EDAName> — export environment dynamic assets individually.
  • EXPORT ALL EDA— export all environment dynamic assets.
  • UPDATE REFERENCES — replace assets and characters references with the versions noticed in assets properties files.

Animation Importer

IMP button on DNA shelf. Import animation data into render scenes through alembic cashes. Allow to work with all animation data at once, by asset types or each asset individually.

  • IMPORT ALL ANIMATION — import all animated assets and camera from to the opened render scene.
  • IMPORT CAMERA — import only camera.
  • <characterNames> — import characters individually
  • IMPORT ALL CHARACTERS — import all characters.
  • <assetNames> — import assets individually.
  • IMPORT ALL ASSETS — import all assets.
  • <EDACode> — import environment dynamic assets individually.
  • IMPORT ALL EDA— import all environment dynamic assets.
  • IMPORT ALL FUR — import fur cashes for all characters.
  • <characterNames> — import fur for characters individually

FX Manager

FXM button on DNA shelf. Create, manage and publish FX scenes and data.

  • [REEL_01] [SEQUENCE] [SHOT] [ ] — set reel, sequence and shot to generate fur dynamic files. If enter character name or names separated with comma (C04:CALF,C05:KIRILLA) fur scenes will be created only for this characters.
  • CREATE FUR SIMULATION SCENE — Run procedure of FUR scenes creation.
  • [REEL_01] [SEQUENCE] [SHOT] FX CODE [ ] — set reel, sequence, shot and <codeFX> to generate FX file.
  • CREATE FX SCENE — Run procedure of FX scene creation.
  • ANALYZE CURRENT FX — Get FX data from file name to publish in FTrack.
  • PUBLISH FX — Publish FX data from field below to FTrack.
  • [ ] — Field with FX data to publish.

Render Manager

RND button on DNA shelf. Rendering and look development tool. Setup shots for rendering: assign materials, create passes, object and shader IDs, setup render settings (image size, render path and name etc ) and export ass for renderfarm rendering.

  • REF LDV DATA — reference material general library and sun and sky system to current scene.
  • DOF — add DOF setup to drive depth of field to a selected camera.
  • ADD FUR — Creates yeti nodes for all character in current scene (based on FTrack info)
  • RENAME MATERIAL — name all nodes of selected shading group network.
  • EXPORT XGEN — export Xgen data for render scenes from lookdev scene (where Xgen developing).
  • IMPORT XGEN — import XGen description in render scene.
  • EXPORT LIGHT GROUP — export group with lights of the shot to light library
  • IMPORT MATERIALS — import material library of each asset from text field.
  • ASSIGN MATERIALS — assign materials to all polygonal object in scene.
    If any material does not exists in scene procedure create:
    • report with list of missing materials
    • selection set MISS_<materialName> and add objects with this material to a set.
  • FOR SELECTED — assign materials to selected polygonal objects with report and set of missing materials. This procedure has detailed per object report, use it for precise diagnostic.
  • SELECT SG ALL GEO — select shading groups of all(or only selected with button SELECT SG SEL) geometry in scene.
  • ADD SHADER ID — add AOV IDs for each shading group in scene if nothing selected. If any shading group selected — adds AOV only for selected SG. Using aiWriteColor method for this: create AOV and add aiWriteColor node to shading network. Refer to a AOV tutorial for explanation.
  • DEL SHADER ID — delete AOV and aiWriteColor node from network for each selected aiWriteColor node, or for all shader IDs if nothing selected.
  • OBJECT ID — add object AOV for each selected object(or group).
  • ADD ASSET ID — add object IDs for each character, asset and environment in scene. Based on naming selection.
  • ADD PASSES — add set of predefined and custom AOVs in current scene(e.g. direct diffuse, indirect diffuse, ambient occlusion etc).
  • RENDER SETTINGS — setup render global for each scene — output name and path, frame format, camera, Arnold settings etc.
  • HIGH and LOW set high and low Arnold sampling settings for final and preview renders.
  • RENDER SHOT — generating of .ass files for each shot starting from frame [101]
  • PUB — publish to FTrack path to EXR render of current shot.

Save next version

Pressing SNV button will save next version of current scene. Scene should has proper name.

Data Publisher

PUB button on DNA shelf. Deliver information about asset to FTrack database. Depending on asset type, data publisher add(publish) information about asset paths: geometry or setup file, fur, materials, environment assets linked to environment(EDA).

FTP Manager

FTP button on DNA shelf. Upload animation scenes and linked references on mirror FTP. Do not load environment assets automatically.

Toolset for 2D branch

In Nuke all DNA tools located in DNA menu.

Shot Assembler NK

Creates nuke script for the shot, noticed in REEL, ESQ, SHOT fields after pressing ASSEMBLE button. Save nuke script with proper name to a proper folder. Add read node with exr file for this shot.

SNV

Save next version of current Nuke script

Split EXR

Select reader with EXR and run in Nuke menu DNA > SPLIT EXR
Script creates shuffle nodes for each layer in EXR file, groped by:

  • Beauty passes
  • Metadata passes
  • Environment ID
  • Character material IDs
  • Environment material IDs
  • Asset IDs

Publish shot

Run in Nuke menu DNA > PUBLISH SHOT to add information about render version of shot to FTrack.