Getting started with .NET API
The Maya .NET API is a system that allows developers to create plug-ins and extensions for Maya using Microsoft’s .NET technology. It includes the following features:
- A system for loading plug-in code from .NET assemblies
- .NET assemblies that plug-in writers can import to access the Maya SDK from .NET languages
- Services for embedding WPF/XAML windows into Maya’s QT system
- Examples written in C# for demonstrating the usage of the system
The Maya .NET API is similar to the Maya Python API in that it is generated from the Maya C++ API. Most classes in the .NET API have a corresponding class in the C++ API with the same name and with a similar interface (that is, a set of functions and classes).
C# classes are proxies for C++ classes.
The system provides the following advantages:
- Allow plug-in writers to accelerate their development of plug-ins by enabling the use of modern tools such as C# and .NET SDKs. The Maya SDK is provided in an idiomatic style for .NET programmers.
- Allow developers to better integrate their existing custom pipeline tools with Maya, and allow artists to have access to critical production tools inside of their content creation environment.
- Allow developers to re-use their existing investment in .NET code and WPF/XAML user interfaces by referencing their assemblies into their Maya plug-ins.
Requirements
The .NET SDK is installed with Maya as of Extension 2 for Maya 2013. The .NET bindings do not work with any other version of Maya (including Maya 2013).
The Maya .NET API uses the .NET 4.5 Framework and is compatible with .NET 4.0 Framework.
It is recommended that you use .NET Framework 4.5 and Microsoft Visual Studio 2012 to compile the examples. However, you can still use .NET Framework 4.0 and Visual Studio 2010 to create a solution and compile the examples.
.NET SDK Files
The Maya .NET SDK constitutes the following files:
- In the
<...>\bin folder:
- openmayacs.dll / swigfiles.dll – The .NET SDK class libraries
- openmayacs.xml - The Visual Studio XML documentation
- In the
devkit\dotnet folder of your Developer Kit installation:
- C# examples files, compiled through provided solutions: examples.sln and wpfexamples.sln.
NOTE:The Developer Kit is available on the Autodesk Developer Network. See Setting up your build environment: Windows environment (64-bit) for more information.
Visual Studio integrated documentation
In addition to using the Maya API C++ reference documentation, the Maya .NET API ships with Visual Studio integrated documentation generated from the C++ reference documentation. This enables:
- Tool tips
- Comments in the auto-generated code files when using go to definition (F12).
- Help in object browser
Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. Please see the Autodesk Creative Commons FAQ for more information.