SD Get More from 3ds Max with Custom Tool Development

Transcription

1 SD Get More from 3ds Max with Custom Tool Development Kevin Vandecar Forge Developer Join the conversation #AU2016

2 bio: Kevin Vandecar Based in Manchester, New Hampshire, US blog:

3 Class summary This class will discuss using the 3ds Max software development kit (SDK) for automating common tasks within 3ds Max software. We will spend time discussing the.net API and the Python environments, and we ll compare them both. The Python SDK is using a newer API called MaxPlus, but it is not fully exposing the C++ API. While.NET API is exposing most of the C++ API, it can sometimes be more difficult to work with. We will compare them and show techniques for automating common tasks, and creating user interfaces to control your tools. This session features 3ds Max. AIA Approved

4 Key learning objectives At the end of this class, you will be able to: Learn how the 3ds Max Python and.net API environments differ Learn how to get started in 3ds Max.NET API developments Learn how to get started in 3ds Max Python development Learn how to create a UI for your custom tools in.net API or Python

5 3ds Max customization environments

6 Customization environments Customize UI MAX Creation Graph.NET API MAXScript.NET API Python Python C++ SDK

7 .NET vs. Python

8 Some key differences for the environments.net Visual Studio debugger nuget Framework Minimally use same Framework version as 3ds Max Can use newer version, but limited by assembly functionalities Python MAXScript editor PyCharm Libraries 2017+: Install to Max custom python 2016-: Use python standard distribution in Max folder

9 Runtime Inspection.NET Reflection Handy especially in strongly typed languages Python Introspection Not as interesting because of loosely typed language

10 Evolution.NET Introduced in chunks Autodesk.Max came in 2012 SAP IntPtr problems Fewer docs Part of C++ SDK docs See help Python More recent First in 2014 Extension Not complete Significant change in 2017 to special Python runtime Separate section of docs See help

11 .NET

12 Why use it?.net API is very mature and in other products the design choice Revit, AutoCAD, Inventor Mature and industry accepted

13 What can you do? Automate tasks Interop with MAXScript Interop via C++/CLI to full SDK plugin Create nice UI elements WPF Use other.net API components Linq

14 Setup Create new C# (or language preference) Class Library Reference assemblies

15 Assemblies Autodesk.Max.dll C++ SDK wrappers AssemblyLoader.dll Allows GUP like loading and functionality CSharpUtilities.dll Various utility classes for.net programming. ExplorerFramework.dll arbitrary scene explorers

16 Assemblies ManagedServices.dll Misc. tools MaxCustomControls.dll Various.NET utilities and UI components. SceneExplorer.dll ExplorerFramework components UiViewModels.dll user actions and customizing the user interface.

17 How is your code loaded 3ds Max looks in the following directory: <Install location>\ 3ds Max 2017\bin\assemblies app store folder

18 How is your code executed? CuiActionCommandAdapter Easily hook into the UI using the Action system and Customize User Interface UiViewModel.dll Assembly Loader Allows loading and operations similar to the C++ Global Utility Plug-in (GUP) AssemblyLoader.dll

19 Interop MAXScript interop By default, classes/functions are exported if public See help Interop via C++/CLI to full SDK plugin See help

20 Debugging To use direct debugger: Set Use Managed Compatibility Mode To Attach: Attach to Managed, Native Code

21 Samples Explode Geometry Available as full App from App Store Geometry Cui Sample code

22 Tips & Tricks Copy Local flag After reference, ensure copy local = false Environment Variables Use these to point to 3ds Max folder Add Post Build Event to copy assembly Copy assembly after successful build to bin\assemblies folder Simplify CuiActionCommandAdapter make a custom abstract base class with common values

23 Tips & Tricks Use reflector tools Make use of Object Browser / other reflector tools Error check: Try and Catch exceptions! Check return values! Mix assembly functionality where appropriate ManagedServices CSharpUtilities

24 What to avoid Even though the Autodesk.Max assembly exposes what appears to be full plugin capability, it is advised by engineering to NOT create a full plugin type. This means you should not create a full plugin derived from Autodesk.Max.Plugins.<types> Use C++ SDK for full plugins

25 Python

26 Why use it? Python is very mature and in other products The M&E choice Maya, MotionBuilder, FBX SDK Python has: large community countless 3rd party libraries MAXScript is: closed in 3ds Max environment. simple yet still it is a new syntax and language to learn

27 What can you do? Automate tasks Interop with MAXScript Tie into other Python pipelines Create nice UI elements Qt Use other Python libraries There is PySide library already included install your own libraries (numpy, Flask, PyQtGraph, etc.)

28 How to work with Python Built-in Scripting Editor MAXScript Listener Python command line

29 Setup There are two modules: MaxPlus module - exposing some parts of C++ SDK functionality pymsx module - exposing the MAXScript runtime

30 How is your code loaded? 3ds Max looks in the following directories: User Scripts directory User Startup Scripts directory Scripts directory Startup Scripts Windows paths specified by the Path environment variable app store folder

31 How is your code executed? First, remember 3ds Max comes with built-in scripting language called MAXScript. Executing files from MAXScript python.executefile demohelloworld.py Execute file from command-line: 3dsmax.exe U PythonHost demohelloworld.py

32 How is your code executed? 2017 Python Console

33 Why two different modules? MaxPlus wrapper over C++ SDK exposes the low level parts of the 3ds Max ie. class ids integrating PySide UI into the 3ds Max window system

34 Why two different approaches? pymsx Exploits the MAXScript runtime itself Anything that is possible in MAXScript, is possible in Python with this module

35 Interop MAXScript and Python can be executed from each other MAXScript can import and use Python libraries Data can be shared between MAXScript and Python

36 Debugging Debugging can be done with PyCharm Must have the FULL version of PyCharm Setup can be tricky See blog post

37 Samples Included with 3ds Max: <Install location>\ 3ds Max 2017\scripts\Python Explode Geometry Geometry See Python specific folder

38 Tips & Tricks Don t pollute global namespace ie. from <lib> import <sub-lib> Use: if name == main idiom. Remember every file is potentially a library Use MAXScript,.NET, or C++ where appropriate Python is not always the answer

39 Autodesk App Store

40 As Consumer 3ds Max: For Example: explode geometry from App Store

41 As Publisher Uses standard install routine Free, Trial, for Fee Entitlement API for desktop Apps Only $$$ 30 day trial

42 Resources and Support

43 Resources for 3ds Max Customization 3ds Max Dev Center: Blogs: Autodesk: 3ds Max Programming forum Others:

44 Questions or Comments? Feel free to contact us later blog:

45 Autodesk is a registered trademark of Autodesk, Inc., and/or its subsidiaries and/or affiliates in the USA and/or other countries. All other brand names, product names, or trademarks belong to their respective holders. Autodesk reserves the right to alter product and services offerings, and specifications and pricing at any time without notice, and is not responsible for typographical or graphical errors that may appear in this document., Inc. All rights reserved.. All rights reserved.