SG-14434: PyMXS support in 3dsMax (#68)

Adds the new tk-3dsmax engine.

README

@@ -1,3 +1,5 @@
+[![Build Status](https://dev.azure.com/shotgun-ecosystem/Toolkit/_apis/build/status/Configs/tk-config-default2?branchName=master)](https://dev.azure.com/shotgun-ecosystem/Toolkit/_build/latest?definitionId=29&branchName=master)
+
 -------------------------------------------------------------------------
 The Shotgun Pipeline Toolkit Default Configuration
 -------------------------------------------------------------------------

azure-pipelines.yml

@@ -0,0 +1,43 @@
+# Copyright (c) 2019 Shotgun Software Inc.
+#
+# CONFIDENTIAL AND PROPRIETARY
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
+# Source Code License included in this distribution package. See LICENSE.
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
+# not expressly granted therein are reserved by Shotgun Software Inc.
+
+# Imports the shared Azure CI tools
+resources:
+  repositories:
+    - repository: templates
+      type: github
+      name: shotgunsoftware/tk-ci-tools
+      ref: refs/heads/master
+      endpoint: shotgunsoftware
+
+# We want builds to trigger for 3 reasons:
+# - The master branch sees new commits
+# - Each PR should get rebuilt when commits are added to it.
+# - When we tag something
+trigger:
+  branches:
+    include:
+    - master
+  tags:
+    include:
+    - v*
+pr:
+  branches:
+    include:
+    - "*"
+
+# This pulls in a variable group from Azure. Variables can be encrypted or not.
+variables:
+- group: deploy-secrets
+
+jobs:
+- template: build-pipeline.yml@templates
+  parameters:
+    skip_tests: true

env/asset.yml

@@ -23,6 +23,7 @@ description: Apps and engines loaded when an Asset is loaded. Since std VFX
 includes:
 - ./includes/frameworks.yml
 - ./includes/settings/tk-3dsmaxplus.yml
+- ./includes/settings/tk-3dsmax.yml
 - ./includes/settings/tk-houdini.yml
 - ./includes/settings/tk-mari.yml
 - ./includes/settings/tk-maya.yml
@@ -40,6 +41,7 @@ includes:
 
 engines:
   tk-3dsmaxplus: "@settings.tk-3dsmaxplus.asset"
+  tk-3dsmax: "@settings.tk-3dsmax.asset"
   tk-houdini: "@settings.tk-houdini.asset"
   tk-mari: "@settings.tk-mari.asset"
   tk-maya: "@settings.tk-maya.asset"

env/asset_step.yml

@@ -17,6 +17,7 @@ includes:
 - ./includes/frameworks.yml
 - ./includes/settings/tk-desktop2.yml
 - ./includes/settings/tk-3dsmaxplus.yml
+- ./includes/settings/tk-3dsmax.yml
 - ./includes/settings/tk-houdini.yml
 - ./includes/settings/tk-mari.yml
 - ./includes/settings/tk-maya.yml
@@ -35,6 +36,7 @@ includes:
 engines:
   tk-desktop2: "@settings.tk-desktop2.all"
   tk-3dsmaxplus: "@settings.tk-3dsmaxplus.asset_step"
+  tk-3dsmax: "@settings.tk-3dsmax.asset_step"
   tk-houdini: "@settings.tk-houdini.asset_step"
   tk-mari: "@settings.tk-mari.asset_step"
   tk-maya: "@settings.tk-maya.asset_step"

env/includes/app_locations.yml

@@ -47,7 +47,7 @@ apps.tk-multi-launchapp.location:
 apps.tk-multi-loader2.location:
   type: app_store
   name: tk-multi-loader2
-  version: v1.19.4
+  version: v1.19.5
 
 # publish2
 apps.tk-multi-publish2.location:
@@ -89,7 +89,7 @@ apps.tk-multi-shotgunpanel.location:
 apps.tk-multi-snapshot.location:
   type: app_store
   name: tk-multi-snapshot
-  version: v0.7.4
+  version: v0.7.5
 
 # workfiles (required for Mari)
 apps.tk-multi-workfiles.location:
@@ -101,7 +101,7 @@ apps.tk-multi-workfiles.location:
 apps.tk-multi-workfiles2.location:
   type: app_store
   name: tk-multi-workfiles2
-  version: v0.11.14
+  version: v0.11.15
 
 # dev utils
 apps.tk-multi-devutils.location:

env/includes/engine_locations.yml

@@ -17,7 +17,12 @@
 engines.tk-3dsmaxplus.location:
   type: app_store
   name: tk-3dsmaxplus
-  version: v0.5.8
+  version: v0.5.9
+
+engines.tk-3dsmax.location:
+  type: app_store
+  name: tk-3dsmax
+  version: v1.0.2
 
 # After Effects
 engines.tk-aftereffects.location:

env/includes/settings/tk-3dsmax.yml

@@ -0,0 +1,112 @@
+# Copyright (c) 2017 Shotgun Software Inc.
+#
+# CONFIDENTIAL AND PROPRIETARY
+#
+# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
+# Source Code License included in this distribution package. See LICENSE.
+# By accessing, using, copying or modifying this work you indicate your
+# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
+# not expressly granted therein are reserved by Shotgun Software Inc.
+#
+
+################################################################################
+
+includes:
+- ../app_locations.yml
+- ../engine_locations.yml
+- ./tk-multi-loader2.yml
+- ./tk-multi-publish2.yml
+- ./tk-multi-screeningroom.yml
+- ./tk-multi-shotgunpanel.yml
+- ./tk-multi-snapshot.yml
+- ./tk-multi-workfiles2.yml
+
+################################################################################
+
+# asset
+settings.tk-3dsmax.asset:
+  apps:
+    tk-multi-about:
+      location: "@apps.tk-multi-about.location"
+    tk-multi-pythonconsole:
+      location: "@apps.tk-multi-pythonconsole.location"
+    tk-multi-screeningroom: "@settings.tk-multi-screeningroom.rv"
+    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel"
+    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmax"
+  menu_favourites:
+  - {app_instance: tk-multi-workfiles2, name: File Open...}
+  location: "@engines.tk-3dsmax.location"
+
+# asset_step
+settings.tk-3dsmax.asset_step:
+  apps:
+    tk-multi-about:
+      location: "@apps.tk-multi-about.location"
+    tk-multi-pythonconsole:
+      location: "@apps.tk-multi-pythonconsole.location"
+    tk-multi-loader2: "@settings.tk-multi-loader2.3dsmax"
+    tk-multi-publish2: "@settings.tk-multi-publish2.3dsmax.asset_step"
+    tk-multi-screeningroom: "@settings.tk-multi-screeningroom.rv"
+    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel.3dsmax"
+    tk-multi-snapshot: "@settings.tk-multi-snapshot.3dsmax.asset_step"
+    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmax.asset_step"
+  location: "@engines.tk-3dsmax.location"
+
+# project
+settings.tk-3dsmax.project:
+  apps:
+    tk-multi-about:
+      location: "@apps.tk-multi-about.location"
+    tk-multi-pythonconsole:
+      location: "@apps.tk-multi-pythonconsole.location"
+    tk-multi-screeningroom: "@settings.tk-multi-screeningroom.rv"
+    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel"
+    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmax"
+  menu_favourites:
+  - {app_instance: tk-multi-workfiles2, name: File Open...}
+  location: "@engines.tk-3dsmax.location"
+
+# sequence
+settings.tk-3dsmax.sequence:
+  apps:
+    tk-multi-about:
+      location: "@apps.tk-multi-about.location"
+    tk-multi-pythonconsole:
+      location: "@apps.tk-multi-pythonconsole.location"
+    tk-multi-screeningroom: "@settings.tk-multi-screeningroom.rv"
+    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel"
+    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmax"
+  menu_favourites:
+  - {app_instance: tk-multi-workfiles2, name: File Open...}
+  location: "@engines.tk-3dsmax.location"
+
+# shot
+settings.tk-3dsmax.shot:
+  apps:
+    tk-multi-about:
+      location: "@apps.tk-multi-about.location"
+    tk-multi-pythonconsole:
+      location: "@apps.tk-multi-pythonconsole.location"
+    tk-multi-screeningroom: "@settings.tk-multi-screeningroom.rv"
+    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel"
+    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmax"
+  menu_favourites:
+  - {app_instance: tk-multi-workfiles2, name: File Open...}
+  location: "@engines.tk-3dsmax.location"
+
+# shot_step
+settings.tk-3dsmax.shot_step:
+  apps:
+    tk-multi-about:
+      location: "@apps.tk-multi-about.location"
+    tk-multi-pythonconsole:
+      location: "@apps.tk-multi-pythonconsole.location"
+    tk-multi-setframerange:
+      location: "@apps.tk-multi-setframerange.location"
+    tk-multi-loader2: "@settings.tk-multi-loader2.3dsmax"
+    tk-multi-publish2: "@settings.tk-multi-publish2.3dsmax.shot_step"
+    tk-multi-screeningroom: "@settings.tk-multi-screeningroom.rv"
+    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel.3dsmax"
+    tk-multi-snapshot: "@settings.tk-multi-snapshot.3dsmax.shot_step"
+    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmax.shot_step"
+  location: "@engines.tk-3dsmax.location"

env/includes/settings/tk-3dsmaxplus.yml

@@ -44,12 +44,12 @@ settings.tk-3dsmaxplus.asset_step:
       location: "@apps.tk-multi-about.location"
     tk-multi-pythonconsole:
       location: "@apps.tk-multi-pythonconsole.location"
-    tk-multi-loader2: "@settings.tk-multi-loader2.3dsmax"
-    tk-multi-publish2: "@settings.tk-multi-publish2.3dsmax.asset_step"
+    tk-multi-loader2: "@settings.tk-multi-loader2.3dsmaxplus"
+    tk-multi-publish2: "@settings.tk-multi-publish2.3dsmaxplus.asset_step"
     tk-multi-screeningroom: "@settings.tk-multi-screeningroom.rv"
-    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel.3dsmax"
-    tk-multi-snapshot: "@settings.tk-multi-snapshot.3dsmax.asset_step"
-    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmax.asset_step"
+    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel.3dsmaxplus"
+    tk-multi-snapshot: "@settings.tk-multi-snapshot.3dsmaxplus.asset_step"
+    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmaxplus.asset_step"
   location: "@engines.tk-3dsmaxplus.location"
 
 # project
@@ -103,10 +103,10 @@ settings.tk-3dsmaxplus.shot_step:
       location: "@apps.tk-multi-pythonconsole.location"
     tk-multi-setframerange:
       location: "@apps.tk-multi-setframerange.location"
-    tk-multi-loader2: "@settings.tk-multi-loader2.3dsmax"
-    tk-multi-publish2: "@settings.tk-multi-publish2.3dsmax.shot_step"
+    tk-multi-loader2: "@settings.tk-multi-loader2.3dsmaxplus"
+    tk-multi-publish2: "@settings.tk-multi-publish2.3dsmaxplus.shot_step"
     tk-multi-screeningroom: "@settings.tk-multi-screeningroom.rv"
-    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel.3dsmax"
-    tk-multi-snapshot: "@settings.tk-multi-snapshot.3dsmax.shot_step"
-    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmax.shot_step"
+    tk-multi-shotgunpanel: "@settings.tk-multi-shotgunpanel.3dsmaxplus"
+    tk-multi-snapshot: "@settings.tk-multi-snapshot.3dsmaxplus.shot_step"
+    tk-multi-workfiles2: "@settings.tk-multi-workfiles2.3dsmaxplus.shot_step"
   location: "@engines.tk-3dsmaxplus.location"

env/includes/settings/tk-multi-loader2.yml

@@ -15,8 +15,8 @@ includes:
 
 ################################################################################
 
-# 3dsmax
-settings.tk-multi-loader2.3dsmax:
+# 3dsmaxplus
+settings.tk-multi-loader2.3dsmaxplus: &settings_tk-multi-loader2_3dsmaxplus
   action_mappings:
     3dsmax Scene: [import, reference]
     Alembic Cache: [import]
@@ -42,6 +42,13 @@ settings.tk-multi-loader2.3dsmax:
     hierarchy: [entity, content]
   location: "@apps.tk-multi-loader2.location"
 
+# 3dsmax
+# Uses the same settings, but a different hook.
+settings.tk-multi-loader2.3dsmax:
+  <<: *settings_tk-multi-loader2_3dsmaxplus
+  actions_hook: "{engine}/tk-multi-loader2/basic/scene_actions.py"
+
+
 # flame
 settings.tk-multi-loader2.flame:
   actions_hook: '{engine}/tk-multi-loader2/flame_loader_actions.py'

env/includes/settings/tk-multi-publish2.yml

@@ -38,7 +38,7 @@ settings.tk-multi-publish2.standalone:
 # ---- 3dsMax
 
 # asset step
-settings.tk-multi-publish2.3dsmax.asset_step:
+settings.tk-multi-publish2.3dsmaxplus.asset_step: &settings_tk-multi-publish2_3dsmaxplus_asset_step
   collector: "{self}/collector.py:{engine}/tk-multi-publish2/basic/collector.py"
   collector_settings:
       Work Template: max_asset_work
@@ -64,7 +64,7 @@ settings.tk-multi-publish2.3dsmax.asset_step:
   location: "@apps.tk-multi-publish2.location"
 
 # shot step
-settings.tk-multi-publish2.3dsmax.shot_step:
+settings.tk-multi-publish2.3dsmaxplus.shot_step: &settings_tk-multi-publish2_3dsmaxplus_shot_step
   collector: "{self}/collector.py:{engine}/tk-multi-publish2/basic/collector.py"
   collector_settings:
       Work Template: max_shot_work
@@ -85,6 +85,15 @@ settings.tk-multi-publish2.3dsmax.shot_step:
   help_url: *help_url
   location: "@apps.tk-multi-publish2.location"
 
+
+# ---- 3dsMax
+
+# Uses the exact same settings. The {engine} resolves the hook at the right location.
+# asset step
+settings.tk-multi-publish2.3dsmax.asset_step: *settings_tk-multi-publish2_3dsmaxplus_asset_step
+# shot step
+settings.tk-multi-publish2.3dsmax.shot_step: *settings_tk-multi-publish2_3dsmaxplus_shot_step
+
 ################################################################################
 
 # ---- Houdini

env/includes/settings/tk-multi-shotgunpanel.yml

@@ -29,8 +29,8 @@ settings.tk-multi-shotgunpanel:
       filters: {}
   location: "@apps.tk-multi-shotgunpanel.location"
 
-# 3dsmax
-settings.tk-multi-shotgunpanel.3dsmax:
+# 3dsmaxplus
+settings.tk-multi-shotgunpanel.3dsmaxplus: &settings_tk-multi-shotgunpanel_3dsmaxplus
   action_mappings:
     PublishedFile:
     - actions: [import]
@@ -53,6 +53,11 @@ settings.tk-multi-shotgunpanel.3dsmax:
       filters: {}
   location: "@apps.tk-multi-shotgunpanel.location"
 
+# 3dsmax
+settings.tk-multi-shotgunpanel.3dsmax:
+  <<: *settings_tk-multi-shotgunpanel_3dsmaxplus
+  actions_hook: "{engine}/tk-multi-shotgunpanel/basic/scene_actions.py"
+
 # houdini
 settings.tk-multi-shotgunpanel.houdini:
   action_mappings:

env/includes/settings/tk-multi-snapshot.yml

@@ -15,18 +15,28 @@ includes:
 
 ################################################################################
 
-# ---- 3dsMax
+# ---- 3dsMaxPlus
 
-settings.tk-multi-snapshot.3dsmax.asset_step:
+settings.tk-multi-snapshot.3dsmaxplus.asset_step: &settings_tk-multi-snapshot_3dsmaxplus_asset_step
   template_snapshot: max_asset_snapshot
   template_work: max_asset_work
   location: "@apps.tk-multi-snapshot.location"
 
-settings.tk-multi-snapshot.3dsmax.shot_step:
+settings.tk-multi-snapshot.3dsmaxplus.shot_step: &settings_tk-multi-snapshot_3dsmaxplus_shot_step
   template_snapshot: max_shot_snapshot
   template_work: max_shot_work
   location: "@apps.tk-multi-snapshot.location"
 
+################################################################################
+
+# ---- 3dsMax
+
+settings.tk-multi-snapshot.3dsmax.asset_step:
+  <<: *settings_tk-multi-snapshot_3dsmaxplus_asset_step
+  hook_scene_operation: "{engine}/tk-multi-snapshot/basic/scene_operation.py"
+settings.tk-multi-snapshot.3dsmax.shot_step:
+  <<: *settings_tk-multi-snapshot_3dsmaxplus_shot_step
+  hook_scene_operation: "{engine}/tk-multi-snapshot/basic/scene_operation.py"
 
 ################################################################################
 

env/includes/settings/tk-multi-workfiles2.yml

@@ -29,7 +29,7 @@ includes:
 # work area. The work area is typically a task or pipeline step
 # and these 'transit' areas can be project, shot, or sequence level.
 
-settings.tk-multi-workfiles2:
+settings.tk-multi-workfiles2: &settings_tk-multi-workfiles2
   entities:
   - caption: Assets
     entity_type: Asset
@@ -77,9 +77,9 @@ settings.tk-multi-workfiles2.launch_at_startup:
 
 ################################################################################
 
-# ---- 3dsmax
+# ---- 3dsmaxplus
 
-settings.tk-multi-workfiles2.3dsmax.asset_step:
+settings.tk-multi-workfiles2.3dsmaxplus.asset_step: &settings_tk-multi-workfiles2_3dsmaxplus_asset_step
   template_publish: max_asset_publish
   template_publish_area: asset_publish_area_max
   template_work: max_asset_work
@@ -105,7 +105,7 @@ settings.tk-multi-workfiles2.3dsmax.asset_step:
       hierarchy: [step]
   location: "@apps.tk-multi-workfiles2.location"
 
-settings.tk-multi-workfiles2.3dsmax.shot_step:
+settings.tk-multi-workfiles2.3dsmaxplus.shot_step: &settings_tk-multi-workfiles2_3dsmaxplus_shot_step
   template_publish: max_shot_publish
   template_publish_area: shot_publish_area_max
   template_work: max_shot_work
@@ -133,6 +133,22 @@ settings.tk-multi-workfiles2.3dsmax.shot_step:
 
 ################################################################################
 
+# ---- 3dsmax
+
+settings.tk-multi-workfiles2.3dsmax:
+  <<: *settings_tk-multi-workfiles2
+  hook_scene_operation: "{engine}/tk-multi-workfiles2/basic/scene_operation.py"
+
+settings.tk-multi-workfiles2.3dsmax.asset_step:
+  <<: *settings_tk-multi-workfiles2_3dsmaxplus_asset_step
+  hook_scene_operation: "{engine}/tk-multi-workfiles2/basic/scene_operation.py"
+
+settings.tk-multi-workfiles2.3dsmax.shot_step:
+  <<: *settings_tk-multi-workfiles2_3dsmaxplus_shot_step
+  hook_scene_operation: "{engine}/tk-multi-workfiles2/basic/scene_operation.py"
+
+################################################################################
+
 # ---- hiero/nukestudio
 
 settings.tk-multi-workfiles2.hiero:

env/project.yml

@@ -16,6 +16,7 @@ description: Apps and Engines when launching with a project only context.
 includes:
 - ./includes/frameworks.yml
 - ./includes/settings/tk-3dsmaxplus.yml
+- ./includes/settings/tk-3dsmax.yml
 - ./includes/settings/tk-desktop.yml
 - ./includes/settings/tk-flame.yml
 - ./includes/settings/tk-houdini.yml
@@ -35,6 +36,7 @@ includes:
 
 engines:
   tk-3dsmaxplus: "@settings.tk-3dsmaxplus.project"
+  tk-3dsmax: "@settings.tk-3dsmax.project"
   tk-desktop: "@settings.tk-desktop.project"
   tk-flame: "@settings.tk-flame.project"
   tk-hiero: "@settings.tk-nuke.hiero.project"

env/sequence.yml

@@ -23,6 +23,7 @@ description: Apps and engines loaded when a Sequence is loaded. Since std VFX
 includes:
 - ./includes/frameworks.yml
 - ./includes/settings/tk-3dsmaxplus.yml
+- ./includes/settings/tk-3dsmax.yml
 - ./includes/settings/tk-houdini.yml
 - ./includes/settings/tk-maya.yml
 - ./includes/settings/tk-motionbuilder.yml
@@ -35,6 +36,7 @@ includes:
 
 engines:
   tk-3dsmaxplus: "@settings.tk-3dsmaxplus.sequence"
+  tk-3dsmax: "@settings.tk-3dsmax.sequence"
   tk-houdini: "@settings.tk-houdini.sequence"
   tk-maya: "@settings.tk-maya.sequence"
   tk-motionbuilder: "@settings.tk-motionbuilder.sequence"

env/shot.yml

@@ -23,6 +23,7 @@ description: Apps and engines loaded when a Shot is loaded. Since std VFX config
 includes:
 - ./includes/frameworks.yml
 - ./includes/settings/tk-3dsmaxplus.yml
+- ./includes/settings/tk-3dsmax.yml
 - ./includes/settings/tk-flame.yml
 - ./includes/settings/tk-houdini.yml
 - ./includes/settings/tk-maya.yml
@@ -38,6 +39,7 @@ includes:
 
 engines:
   tk-3dsmaxplus: "@settings.tk-3dsmaxplus.shot"
+  tk-3dsmax: "@settings.tk-3dsmax.shot"
   tk-flame: "@settings.tk-flame.shot"
   tk-houdini: "@settings.tk-houdini.shot"
   tk-maya: "@settings.tk-maya.shot"

env/shot_step.yml

@@ -17,6 +17,7 @@ includes:
 - ./includes/frameworks.yml
 - ./includes/settings/tk-desktop2.yml
 - ./includes/settings/tk-3dsmaxplus.yml
+- ./includes/settings/tk-3dsmax.yml
 - ./includes/settings/tk-houdini.yml
 - ./includes/settings/tk-maya.yml
 - ./includes/settings/tk-motionbuilder.yml
@@ -33,6 +34,7 @@ engines:
   # referencing the DCC-specific shot_step environments included above
   tk-desktop2: "@settings.tk-desktop2.all"
   tk-3dsmaxplus: "@settings.tk-3dsmaxplus.shot_step"
+  tk-3dsmax: "@settings.tk-3dsmax.shot_step"
   tk-houdini: "@settings.tk-houdini.shot_step"
   tk-maya: "@settings.tk-maya.shot_step"
   tk-motionbuilder: "@settings.tk-motionbuilder.shot_step"