Extensões
As extensões são uma poderosa ferramenta de desenvolvimento no ecossistema do Dynamo. Elas permitem que os desenvolvedores direcionem a funcionalidade personalizada com base nas interações e lógica do Dynamo. As extensões podem ser divididas em duas categorias principais, extensões e extensões de vista. Como a nomenclatura indica, a estrutura de extensão da vista permite estender a interface do usuário do Dynamo registrando itens de menu personalizados. As extensões regulares operam de forma muito semelhante, exceto a interface do usuário. Por exemplo, podemos compilar uma extensão que registra informações específicas no console do Dynamo. Esse cenário não requer uma interface do usuário personalizada e, portanto, também pode ser realizado usando uma extensão.
Estudo de caso de extensão
Seguindo o exemplo SampleViewExtension do repositório Github do DynamoSamples, vamos percorrer as etapas necessárias para criar uma janela simples sem janela restrita que exibe os nós ativos no gráfico em tempo real. Uma extensão de vista requer que criemos uma interface do usuário para a janela e vinculemos valores a um modelo de vista.
A janela de extensão da vista foi desenvolvida seguindo o exemplo SampleViewExtension no repositório Github.
Embora possamos compilar o exemplo desde o início, também é possível fazer o download e criar o repositório DynamoSamples para servir como referência.
Repositório DynamoSamples: https://github.com/DynamoDS/DynamoSamples
Este percurso virtual fará referência específica ao projeto denominado SampleViewExtension encontrado em
DynamoSamples/src/
.
Como implementar uma extensão de vista
Uma extensão de vista tem três partes essenciais:
Uma montagem contendo uma classe que implementa
IViewExtension
, bem como uma classe que cria um modelo de vistaUm arquivo
.xml
que informa ao Dynamo onde ele deve procurar por essa montagem no tempo de execução e o tipo de extensãoUm arquivo
.xaml
que vincula os dados à exibição gráfica e determina a aparência da janela
1. Criar a estrutura do projeto
Comece criando um novo projeto Class Library
chamado SampleViewExtension
.
Criar um novo projeto selecionando
File > New > Project
Selecionar
Class Library
Nomear o projeto
SampleViewExtension
Selecionar
Ok
Neste projeto, precisaremos de duas classes. Uma classe implementará IViewExtension
e a outra que implementará NotificationObject.
IViewExtension
conterá todas as informações sobre como nossa extensão será implantada, carregada, referenciada e eliminada. NotificationObject
fornecerá notificações de alterações no Dynamo e IDisposable
quando ocorrer uma alteração, a contagem será atualizada de acordo.
Um arquivo de classe denominado
SampleViewExtension.cs
que implementaráIViewExtension
Um arquivo de classe denominado
SampleWindowViewMode.cs
que implementaráNotificationObject
Para usar o IViewExtension
, precisaremos do pacote WpfUILibrary NuGet. A instalação desse pacote instalará automaticamente os pacotes Core, Services e ZeroTouchLibrary.
Selecionar a biblioteca WpfUIL
Selecionar
Install
para instalar todos os pacotes dependentes
2. Implementar a classe IViewExtension
Na classe IViewExtension
, vamos determinar o que acontece quando o Dynamo é iniciado, quando a extensão é carregada e quando o Dynamo é fechado. No arquivo de classe SampleViewExtension.cs
, adicione o seguinte código:
A classe SampleViewExtension
cria um item de menu clicável para abrir a janela e conecta-a ao modelo de vista e à janela.
public class SampleViewExtension : IViewExtension
SampleViewExtension
herda da interface doIViewExtension
e fornece tudo o que precisamos para criar o item de menu.sampleMenuItem = new MenuItem { Header = "Show View Extension Sample Window" };
cria um MenuItem e o adiciona ao menuView
.
O item de menu
sampleMenuItem.Click += (sender, args)
aciona um evento que abrirá uma nova janela quando o item de menu for clicadoMainGrid = { DataContext = viewModel }
define o contexto de dados para a grade principal na janela, referindo-se aMain Grid
no arquivo.xaml
que criaremosOwner = p.DynamoWindow
define o proprietário da janela pop-out como Dynamo. Isso significa que a nova janela depende do Dynamo, portanto, ações como minimizar, maximizar e restaurar o Dynamo farão com que a nova janela siga esse mesmo comportamentowindow.Show();
exibe a janela onde as propriedades adicionais da janela foram definidas
3. Implementar o modelo de vista
Agora que estabelecemos alguns dos parâmetros básicos da janela, adicionaremos a lógica para responder a vários eventos relacionados ao Dynamo e instruiremos a interface do usuário a atualizar com base nesses eventos. Copie o seguinte código para o arquivo de classe SampleWindowViewModel.cs
:
Essa implementação da classe de modelo de vista ouve o CurrentWorkspaceModel
e aciona um evento quando um nó é adicionado ou removido do espaço de trabalho. Isso gera uma alteração de propriedade que notifica a interface do usuário ou elementos vinculados que os dados foram alterados e precisam ser atualizados. O getter ActiveNodeTypes
é chamado, o que chama internamente uma função getNodeTypes()
de ajuda adicional. Essa função interage em todos os nós ativos na tela, preenche uma sequência de caracteres contendo os nomes desses nós e retorna essa sequência para nossa associação no arquivo .xaml para ser exibido em nossa janela pop-out.
Com a lógica principal da extensão definida, agora vamos especificar os detalhes de aparência da janela com um arquivo .xaml
. Tudo que precisamos é uma janela simples que exiba a sequência de caracteres usando a associação de propriedade ActiveNodeTypes
noTextBlock
Text
.
Clicar com o botão direito do mouse no projeto e selecionar
Add > New Item...
Selecionar o modelo Controle de usuário que vamos alterar para criar uma janela
Nomear o novo arquivo
SampleWindow.xaml
Selecionar
Add
No código da janela .xaml
, precisaremos vincular SelectedNodesText
a um bloco de texto. Adicione o seguinte código a SampleWindow.xaml
:
Text="{Binding ActiveNodeTypes}"
vincula o valor da propriedade deActiveNodeTypes
emSampleWindowViewModel.cs
ao valorTextBlock
Text
na janela.
Agora, inicializaremos a janela de amostra no arquivo de backup .xaml C# SampleWindow.xaml.cs
. Adicione o seguinte código a SampleWindow.xaml
:
A extensão da vista agora está pronta para ser criada e adicionada ao Dynamo. O Dynamo requer um arquivo xml
para registrar nossa saída .dll
como uma extensão.
Clicar com o botão direito do mouse no projeto e selecionar
Add > New Item...
Selecionar o arquivo XML
Nomear o arquivo
SampleViewExtension_ViewExtensionDefinition.xml
Selecionar
Add
O nome do arquivo segue a norma do Dynamo para fazer referência a uma montagem de extensão como esta:
"extensionName"_ViewExtensionDefinition.xml
No arquivo xml
, adicione o seguinte código para informar ao Dynamo onde procurar a montagem de extensão:
Neste exemplo, compilamos a montagem na pasta de projeto padrão do Visual Studio. Substitua o destino
<AssemblyPath>...</AssemblyPath>
pela localização da montagem.
A última etapa é copiar o arquivo SampleViewExtension_ViewExtensionDefinition.xml
para a pasta de extensões de vista do Dynamo localizada no diretório de instalação C:\Program Files\Dynamo\Dynamo Core\1.3\viewExtensions
do Dynamo Core. É importante observar que há pastas separadas para extensions
e viewExtensions
. Colocar o arquivo xml
na pasta incorreta pode causar falha ao carregar corretamente no tempo de execução.
O arquivo
.xml
que copiamos para a pasta de extensões de vista do Dynamo
Esta é uma introdução básica às extensões da vista. Para um estudo de caso mais sofisticado, consulte o pacote DynaShape, um projeto de código aberto no Github. O pacote usa uma extensão de vista que permite a edição ao vivo na vista do modelo do Dynamo.
É possível fazer o download de um instalador de pacote para o DynamoShape do Fórum do Dynamo: https://forum.dynamobim.com/t/dynashape-published/11666
O código-fonte pode ser clonado do Github: https://github.com/LongNguyenP/DynaShape
Last updated