Super Powered Dynamo. Dynamo Extensions - with great power comes great responsibility - uncle ben

Transcription

1 Super Powered Dynamo Dynamo Extensions - with great power comes great responsibility - uncle ben

2 OverView For Today 8:30-9:00 Breakfast and Setup 9:00-9:30 Introductions and Extension Ideas Exchange 9:30-11:00 Extensions Presentation 11:00-12:00 Make an Extension (Part 1) 12:00-13:00 Lunch 13:00-16:00 Make an Extension (Part 2) 16:00-17:00 Share-Out/ Conclusion

3 Extensions Expressive Power DS Graph Host integration UI Nodes Zero Touch Custom Nodes Difficulty

4 When to Use an Extension Control over the graph (add,remove nodes etc). Add new UI or functionality that is external to a single node. Core functionality that needs improvement - simple to add an extension which will ship with DynamoCore- good model for contribution to Dynamo itself. Don t feel like learning about abstract syntax trees today

5 What can we do with them? Create an instance of your extension when Dynamo starts. Add MenuItems to Dynamo Window. Get a reference to CurrentWorkspace. Execute Model commands on The Dynamo Model (application). Get a reference to the DynamoView - now you have as much control as Dynamo Sandbox or DynamoRevit. I.E. Control Dynamo like a application.

6 Extensions Architecture Extensions are composed of 2 parts: 1. a.net assembly that contains a class which implements IViewExtension or IExtension.

7 Extensions Architecture 2. An xml Extension manifest file which tells Dynamo which class to instantiate to start your extension. <ViewExtensionDefinition> <AssemblyPath>..\Notifications.dll</AssemblyPath> <TypeName>Dynamo.Notifications.NotificationsViewExtension</Ty pename> </ViewExtensionDefinition>

8 Extensions Architecture Dynamo looks for extension manifest files at startup in these folders in the Dynamo core install folder. If it finds one, it tries to create an instance of it. Naming is important! Dynamo/Extensions MyExtension_Extension.xml Dynamo/ViewExtensions MyExtension_ViewExtension.xml

9 Dynamo Architecture(a brief aside) DynamoCoreWPF.dll DynamoCore.dll

10 Extensions Architecture Instantiate Extensions Instantiate ViewExtensions Call Loaded() on Extensions Call Loaded() on ViewExtensions Shutdown() View Extensions At Startup Dynamo calls two methods on your extension: StartUp(Params): called when Dynamo starts loading. Loaded(Params): called when Dynamo is finished loading. When these are called exactly, depends on if you are writing an Extension or ViewExtension Dynamo Call StartUp() Model Startupon Extensions Call StartUp() on ViewExtensions DynamoView Startup Shutdown() on Extensions

11 Composition of Extensions Taking advantage of MVVM ViewExtension1 ViewExtension2 Extensions Manager (model)extension ViewExtension3

12 Extension Startup + Loaded Params Making stuff happen. (dynamo APIs) ReadyParams ViewLoadedParams WorkspaceModels CurrentWorkspaceModel CommandExecutive NotificationRecieved CurrentWorkspaceChanged DynamoMenu BackGroundPreviewViewModel RenderPackageFactory DynamoWindow* CommandExecutive AddMenuItem SelectionCollectionChanged StartupParams AuthProvider Preferences PathManager LibraryLoader CustomNodeManager DynamoVersion ViewStartupParams ExtensionManager

13 Dirty Tricks Making more stuff happen. ViewLoadedParams.DynamoWindow.DataContext as DynamoViewModel Don t do this unless you have to - it may stop working.

14 Let s get started. For this demo we re going to run our extension in Dynamo Sandbox, so make sure you can build and run Dynamo Sandbox using the Dynamo repo: Dynamo

15 Let s get started. DynamoSamples/ SampleViewExtension DynamoSamples

16 Sample WPF extension(from DynamoSamples repo) Create a new visual studio project. Reference some Dynamo nugets. Implement an IViewExtension. Add a menu item. Load it in Dynamo. Simple! ;)

17 Sample WPF extension diagram Window Dynamo View Extension Data Binding ViewModel Current Workspace Model Workspace.Nodes Reference

18 Sample WPF extension Create a new Visual studio class library project. (target.net 4.5 minimum) Reference required Dynamo Nugets: DynamoCore and DynamoCoreWPFUI Project-> Manage Nuget Packages->Browse

19 Sample WPF extension create a class that implements IViewExtension Loaded(viewParams) is used to add our main logic and menu Item

20 Sample WPF extension Create our viewmodel which will contain our actual logic and raise events to update the view. For now we just save the ready params.

21 Sample WPF extension Use the ready params to respond to events from Dynamo and update our UI.

22 Sample WPF extension Window Display a string some node names... Data Binding : ActiveNodeTypes ViewModel 1. Recalculate Nodes in graph. 2. RaisePropertyChanged("ActiveNodeTypes"); Current Workspace Model Event: Nodes Added/Removed

23 Sample WPF extension Implement our window using XAML. Add new WPF usercontrol to project. Bind to a property called ActiveNodeTypes

24 Sample WPF extension Implement our Loaded() method logic using our viewmodel and window.

25 Sample WPF extension Add an xml file to the project (SampleViewExtension_ViewExtension.xml) <ViewExtensionDefinition> <AssemblyPath>..\SampleViewExtension.dll</AssemblyPath> <TypeName>SampleViewExtension.SampleViewExtension</TypeName> </ViewExtensionDefinition>

26 Sample WPF extension Dynamo/bin/AnyCPU/Debug/ViewExtensions/SampleView_ViewExtension.xml Dynamo/bin/AnyCPU/Debug/SampleViewExtension.dll

27 Advanced Samples Executing Commands on the Dynamo Model and Dynamo View Model. Execute model commands See: Dynamo\src\DynamoCore\Models\RecordableCommands.cs Execute viewmodel commands not guaranteed. p.commandexecutive.executecommand var VM = ViewLoadedParams.DynamoWindow.DataContext as DynamoViewModel; (new DynamoModel.ForceRunCancelCommand(true, false), //workspace view model command this.uniqueid, VM.CurrentSpaceViewModel.ResetFitViewToggleCommand.Execute(null); this.name) //dynamoviewmodel command VM.AddToSelectionCommand.Execute(someNode);

28 Advanced Samples Injecting UI into other views.

29 Advanced Samples Injecting UI into other views. extensionworkshop A hack to illustrate injecting some wpf control whenever the view is updated performance implications and other caching issues with this code.

30 Incoming Changes: Investigating Package Manager distribution of extensions. Loading sequence might change a bit. Loaded Parameters will likely also contain a reference to StartUp Params. It would be good to know now- or soon, before 2.0 release what APIs you are missing from the extensions APIs.

31 Project Ideas: Tracking graph changes by watching workspace collection modified events. An extension that finds missing dependencies and reports what package they are in. Write your own graph UI. Execution results view. MiniMap. Inject UI into base nodeview. Improve background preview.

32 Your Turn!