DUI: Re-implement logic of getting know ElementType of each node

[aosyatnik]

This is the first PR, that is connected to task "Show category type on hover mouse".

Purpose

On hover over the library item, the type of add-on is display to its right. PKG / DLL

If Package contains custom nodes, these custom nodes consider as package members. The same with dlls. (if package contains dll, this dll considers as package member)

Solution

I want to add new property ElementType, which can be RegularNode, RegularCategory, CustomNode, CustomDll, Package.

Overview

If user imports custom dll, it should be consider as custom dll.
If user opens custom node, it should be consider as custom node.
If user loads package(with custom dlls and custom nodes), they should be consider as package members.

BUT for Dynamo there is no difference, if custom node/dll is part of package or not.
That's why I added new properties IsPackageMember and IsBuiltIn for Custom node and Usual node respectively.

Since Dynamo uses the same functions to load custom nodes/dlls during importing Packages and simple importing/opening, the only posibily, to determine is it member of Package or not, is, when we call Package Manager, say to loading method THIS IS Package Member.

Reviewers

@Benglin , please take a look.

Link to YouTrack:
MAGN-5740 DUI: Re-implement logic of getting know ElementType of each node

[aosyatnik]

If custom node is loaded with PackageLoader it's package member!

[Benglin]

Should we use Any here instead of All and not iterate through all the sub elements? Also, the last return can now be ElementTypes.None after the above change.

[aosyatnik]

Hi, @Benglin . I thought about that and had little conversation with @elayabharath .
We can have next situation: in "Core" user adds some custom node or custom dll. But even with new added node/dll Core should remain as regular category... As well as other builtin categories e.g. operators, geometry.

[Benglin]

Yes, so we are going to just return ElementTypes.None here always?

[aosyatnik]

I think next structure:
Core -> ElementTypes.BuiltIn
Core, inside of which added some custom node -> ElementTypes.None
Category with just user's custom nodes -> ElementTypes.CustomNode
Category with just user's imported assembly -> ElementTypes.ZeroTouch
Rhynamo -> ElementTypes.Packaged

I think we can use None for mixed categories...

[aosyatnik]

Case for "Interactive" dlls. E.g. Color Range.

[Benglin]

I'd prefer this to be done less frequently, I'm imagining this ElementType to be called each time the UI needs the information to display an icon, then that might be too many evaluation on these collections entries and subCategories. If we can do them when these two collection changed, then it's one-time evaluation:

private void OnCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
{
    // Perform the "entries.Any" and "subCategories.Any" calls here, then set "ElementType"...
    if (entries.Any ... && subCategories.Any ...)
        ElementType = ElementTypes.BuiltIn;
}

public ElementTypes ElementType { get; private set; }

If you can do a count and see if we get more calls for ElementType.get or OnCollectionChanged, then decide which is the best way to go about doing it. Please let me know.

[aosyatnik]

You are right... I tried. Element type called MUCH frequently then Collection Changed.

First number is ElementTypeCalled, second number is CollectionChanged.

[aosyatnik]

Hi, @Benglin .
Finally I found the best solution of how and where to determine ElementType!
The best solution to determine it during mouse over UI element, BUT I have to determine it just ONCE. That means if type is None, we have to fire DetermineElementType(). So, there is no need to determine type everytime mouse moves into control.
I also tried to determine type during CollectionChanged event. But it turned out, that it takes more iterations, than the first case.

[Benglin]

Thanks @aosyatnik, this looks good. I have two questions:

1. Is BuiltIn type really needed and used anywhere?
2. I don't see any XAML file update, is that coming from another PR later?

[aosyatnik]

Thanks @Benglin .
IsBuiltIn is used in FunctionDescriptor.

if (functionDescriptor.IsBuiltIn)
               ElementType |= ElementTypes.BuiltIn;

BuiltIn type is used to determine whether zerotouch library(e.g. geometry) comes with dynamo or was imported by user.

Xaml will be in next PR.

[Benglin]

Thanks for doing this, @aosyatnik! LGTM.