AEC DevBlog

Attach Search or SelectionSet to a Timeliner Task

By Xiaodong Liang

TimelinerSelection.CopyFrom allows you copy explicit selected items, a Search, a Selection, SelectionSourceCollection. SelectionSourceCollection is a collection of SelectionSources, while SelectionSource represents a reference to a source that can generate a selection on demand, generally a kind of middleware when you want to attach SelectionSet to Timeliner task.

The following code demos the two scenarios. It assumes the document has two Timeliner tasks, current search is available, and at least one SelectionSet exists. The code checks the tasks in first level only. It will attach current Search to the first task, and attach first SelectionSet to the second task.

 

 
using Nw = Autodesk.Navisworks.Api;
using Tl = Autodesk.Navisworks.Api.Timeliner;


      public override int Execute(params string[] parameters)
        { 
            Document oDoc = Autodesk.Navisworks.Api.Application.ActiveDocument;

            

            try
            {
                Nw.Document doc = Nw.Application.ActiveDocument;
                Nw.DocumentParts.IDocumentTimeliner tl = doc.Timeliner;
                Tl.DocumentTimeliner tl_doc = (Tl.DocumentTimeliner)tl;

                //assume we check the tasks in first level only

                SavedItem parentItem = tl_doc.TasksRoot;


                if (tl_doc.Tasks.Count > 1)
                {
                    //test with the first and second tasks only

                    //first task, attach a Search Set
                    Tl.TimelinerTask oTask1 = tl_doc.Tasks[0] as Tl.TimelinerTask;

                    if (!doc.CurrentSearch.ToSearch().IsClear)
                    {
                        //if a current search exists
                        SelectionSet oMySet = new SelectionSet(oDoc.CurrentSearch.ToSearch());

                        //attach selection set to the task
                        Tl.TimelinerTask oCopyTask1 = oTask1.CreateCopy();
                        oCopyTask1.Selection.CopyFrom(doc.CurrentSearch.ToSearch());
                        tl_doc.TaskReplaceWithCopy((GroupItem)parentItem, 0, oCopyTask1);
                         
                    }

                    //second task, attach a Selection Set
                    Tl.TimelinerTask oTask2 = tl_doc.Tasks[1] as Tl.TimelinerTask;

                    if (doc.SelectionSets.RootItem.Children.Count > 0)
                    {    
                        SelectionSet oOneSet = doc.SelectionSets.RootItem.Children[0] as SelectionSet ;

                         SelectionSourceCollection oSetSourceColl = new SelectionSourceCollection();
                         SelectionSource oSetSource =doc.SelectionSets.CreateSelectionSource(oOneSet);
                        oSetSourceColl.Add(oSetSource);

                        //attach selection set to the task
                        Tl.TimelinerTask oCopyTask2 = oTask2.CreateCopy();
                        oCopyTask2.Selection.CopyFrom(oSetSourceColl);
                        tl_doc.TaskReplaceWithCopy((GroupItem)parentItem, 1, oCopyTask2);
                    }
                    
                }

               
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.ToString());
            }
         
            return 0;
        }
 

>
                        

Manipulate Simulation Appearance and Task Type

By Xiaodong Liang

From help of product: 

The task type defines how the items attached to the task will be displayed during simulation. For example, a default construction sequence would start with all items hidden, as the task starts the attached items will be displayed in transparent green, then as the task ends the attached items will be displayed as they are in the normal model display. Task types themselves can be defined and new types created on the Configure Tab.

Each task has a task type associated with it, which specifies how the items attached to the task are treated (and displayed) at the start and end of the task during simulation. The available options are:

• None - the items attached to the task will not change.
• Hide - the items attached to the task will be hidden.
• Model Appearance - the items attached to the task will be displayed as they are defined in the model. This may be the original CAD colors or, if you have applied color and transparency overrides in Autodesk Navisworks, then these will be displayed.
• Appearance Definitions - enables you to choose from the list of Appearance Definitions, including ten predefined appearances and any custom appearances you have added.

 

 

The corresponding API are:

• SimulationTaskType:A Simulation Task Type informs the Simulation Engine how models attached to a TimelinerTask should be represented at different times during the simulation
• SimulationAppearance: referenced by SimulationTaskTypes objects
• DocumentTimeliner.SimulationAppearanceAddCopy: Adds a copy of the SimulationAppearance at the end of the collection to the DocumentTimeliner
• DocumentTimeliner.SimulationTaskTypeAddCopy: Adds a copy of the SimulationTaskType at the end of the collection to the DocumentTimeliner

This is a code pieces that demos how to create a custom appearance and a custom task type. In this task type, its start status links to the custom appearance.

 

 

     
using Nw = Autodesk.Navisworks.Api;
using Tl = Autodesk.Navisworks.Api.Timeliner;

   public override int Execute(params string[] parameters)
        { 
            Document oDoc = Autodesk.Navisworks.Api.Application.ActiveDocument; 

            try
            {
                Nw.Document doc = Nw.Application.ActiveDocument;
                Nw.DocumentParts.IDocumentTimeliner tl = doc.Timeliner;
                Tl.DocumentTimeliner tl_doc = (Tl.DocumentTimeliner)tl;

                
                Tl.SimulationAppearance newSimAppearance = 
         new Tl.SimulationAppearance("myAppearance", new Color(1, 1, 1), 0.5);
                 tl_doc.SimulationAppearanceAddCopy(newSimAppearance);

                 Tl.SimulationTaskType newTaskType = new Tl.SimulationTaskType();
                 newTaskType.DisplayName = "myTaskType";
                 newTaskType.StartStatus.AppearanceMode = Tl.SimulationAppearanceMode.UserAppearance;
                 newTaskType.StartStatus.SimulationAppearanceName = "myAppearance";
                 tl_doc.SimulationTaskTypeAddCopy(newTaskType);
                     
                 
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.ToString());
            }
         
            return 0;
        }

Update SelectionSet

By Xiaodong Liang

We have some articles on how to add  new SelectionSet. I got a question how to update a SelectionSet. The customer said this object (from the collection of DocumentSelectionSets) is read-only.

In general, to modify a .NET object of Navisworks, you would need to make a copy of the original object (CreateCopy method), modify the copy, and copy to the original object (CopyFrom). Normally, a collection object provide the relevant copy methods. In DocumentSelectionSets, they are:

1. ReplaceWithCopy(Int32, SavedItem)  Replaces item at given index within Value with a copy of item 
2. ReplaceWithCopy(GroupItem, Int32, SavedItem): Replaces item from the specified parent group with a copy of item

I’d recommend the second method as it clearly indicates the relationship of an item and its parent.

So,
1.    get the parent item of the SelectionSet you want to modify. In default, the SelectionSet in first level is actually included in a root item which is invisible in UI.
2.    get the index the item resides in the group (parent)
3.    make a copy of the original item, modify the relevant properties.
4.    call ReplaceWithCopy to update the original item.

The following code demos how to update an item named ‘mytestset’. Assume some other objects are selected in advanced. The code will update the SelectionSet with a new name and the current selection.

 

public override int Execute(params string[] parameters)

{    

    try

    {

        string output =

            ModifySelectionSetContent(

            Autodesk.Navisworks.Api.Application.

            ActiveDocument.SelectionSets.RootItem,

            Autodesk.Navisworks.Api.Application.

            ActiveDocument.Title,

            "");

                 

    }

    catch (Exception ex)

    {

        // any exception

        System.Diagnostics.Debug.Write(ex.ToString());

    }

    return 0;

 }

 

 public string ModifySelectionSetContent(
     SavedItem item,

     string label,

     string lineText)

{

    //set the output

    string output = lineText + "+ " + label + "\n";

 

    //See if this SavedItem is a GroupItem

    if (item.IsGroup)

    {

        //Indent the lines below this item

        lineText += "   ";

 

        int index = 0;

        //iterate the children and output

        foreach (SavedItem childItem in
               ((GroupItem)item).Children)

        {

            output += 
                ModifySelectionSetContent(childItem,

                childItem.DisplayName,

                lineText);

            if (childItem.DisplayName == "mytestset")

            {

                SelectionSet oSet =
                  childItem as SelectionSet;

                SelectionSet copyItem =      

                 oSet.CreateCopy() as SelectionSet;

                //change name

                copyItem.DisplayName += "_updated";

                //change selection

                copyItem.ExplicitModelItems.CopyFrom(

                          

                Autodesk.Navisworks.Api.Application.

                     ActiveDocument.CurrentSelection.SelectedItems);

                DocumentSelectionSets oSets =

                    Autodesk.Navisworks.Api.Application.

                    ActiveDocument.SelectionSets;

                oSets.ReplaceWithCopy((GroupItem)item,

                                     index, copyItem);

            }

            index ++;

 

        }

    }

 

    //return the node information

    return output;

}

Insert Common SelectionSet to Folder

By Xiaodong Liang

SelectionSets is a collection. It can contain Folder and common SelectionSet. A Folder is a GroupItem that can include common SelectionSet as well. The code below is a demo on how to create a common SelectionSet and a Folder, and how to move the common set to the folder.

public void testSelectionSet()

{

    Document oDoc =

       Autodesk.Navisworks.Api.Application.ActiveDocument;

 

    // get the selection sets

    DocumentSelectionSets oSets =

            oDoc.SelectionSets;

 

     // create a search and conditions

    Search s = new Search();

 

    SearchCondition sc =

        SearchCondition.HasPropertyByDisplayName("Element",

                                                "Category");

    s.SearchConditions.Add(

sc.EqualValue(VariantData.FromDisplayString("Walls")));

 

    //set the selection to everything

    s.Selection.SelectAll();

    s.Locations =

        SearchLocations.DescendantsAndSelf;

 

    SavedItem newItem = new SelectionSet(s);

    newItem.DisplayName = "MySearchSet";

    //add to the end

    oSets.AddCopy(newItem);

 

    //folder

    FolderItem oFolder = new FolderItem();

    oFolder.DisplayName = "MyFolder";

    // add to the end

    oSets.AddCopy(oFolder);

 

    try

    {               

        //index of the common selection set        

        int indexOfSaveditem = oSets.Value.Count - 2;      

            

        // move the  selection set  to the folder         

        oSets.Move(oSets.RootItem, indexOfSaveditem,

            (GroupItem)oSets.Value.Last<SavedItem>(), 0);

    }

    catch (Exception ex)

    {

        MessageBox.Show(ex.ToString());

    }

}

Create New Saved Viewpoint in Javascript

By Xiaodong Liang

The process to create a saved viewpoint in COM API is:

1. make a copy of the current view. It is the anonymous viewpoint.
2. create a new object with the type InwOpView
3. attach the anonymous viewpoint to the new view.
4. add the new view to the saved viewpoints collection

The codes below demonstrates the process. it also shows how to switch to the new view.

function createView1()

{

    //assume nwviewer is the object of ActiveX control.

    var state = nwviewer.state;

    var savedviewscount =

        state.SavedViews().count;

   

    //check if "MyView1" exists

    var hasView1 = false;

    for(var i=1; i <= savedviewscount;i++ ){

        var eachView =  state.SavedViews().Item(i);

        {

            if(eachView.Name == "MyView1")

            {

                hasView1 = true;

                break;

            }

        }

    }

   

    if(!hasView1)

    {

        //make a copy of the current view. It is the anonymous viewpoint.

        var currentView =

           state.CurrentView.Copy();

        //create a new object with the type:

        var oNewView =

           state.ObjectFactory( state.GetEnum("eObjectType_nwOpView")) ;

        oNewView.Name = "MyView1";

       

        //attach the anonymous viewpoint to the new view.             

        oNewView.anonview = currentView;

        //add the new view to the saved viewpoints collection

        state.SavedViews().Add(oNewView);               

    }

}

 

function applyView1()

{

    //assume nwviewer is the object of ActiveX control.

    var state = nwviewer.state;

    var savedviewscount = state.SavedViews().count;

 

    //check if "MyView1" exists

    var hasView1 = false;

    for (var i = 1; i <= savedviewscount; i++) {

        var eachView = state.SavedViews().Item(i);

        {

            if (eachView.Name == "MyView1") {

                hasView1 = true;

                break;

            }

        }

    }

 

    if (hasView1) {

        //if "MyView1" exists, switch the view to "MyView1"

        state.ApplyView(eachView);

    }

}

 

Modify Built-In Ribbon

By Xiaodong Liang

Question:
I wanted to modify the title of the buinlt-in ribbon tab and panel, such as [Tool Add-ins 1], [Tool Add-ins 2], [Tool Add-ins 3].

Solution
Navisworks also uses the same library to present a Ribbon: AdWindows.dll
This provides a public API under the namespace Autodesk.Windows

Here is the examples of using it inside

Revit:
http://thebuildingcoder.typepad.com/blog/2011/02/pimp-my-autocad-or-revit-ribbon.html

Inventor:
http://adndevblog.typepad.com/manufacturing/2014/01/modify-ribbon-and-menu-items.html

but it's not a officially supported approach. And some functions like adding a command button to the Ribbon are not supported. So we cannot guarantee the behaviors. When using it, take care and make sure that everything is working as expected.

For the question to modify title of the built-in ribbon tab and panel, the code snippet would be:

public void modifyRibbon()

{

    RibbonTabCollection oTabs = Autodesk.Windows.ComponentManager.Ribbon.Tabs;

    RibbonTab oCloneTab = null;

    foreach(RibbonTab oTab in oTabs)

    { 

        if (oTab.Title == "Tool Add-ins 1")

        {                

            oTab.Title = "MyTab1"; 

            RibbonPanelCollection oPanels =
                                    oTab.Panels;

              

            foreach (RibbonPanel oRP in oPanels)

            {

                if (oRP.Source.Title ==
                             "Tool Add-ins 1")

                {

                    oRP.Source.Title =
                             "MyTab1_Panel1";

                    break;

                }

            }

            break; 

        }            

    }

}

Transform Object with a Series of Moves

By Xiaodong Liang

Question:
I am trying to apply a series of moves with time delay to an object in Navisworks using OverridePermanentTransform and System.Threading.Thread.Sleep(), but Navisworks delays first then applies the moves at the same time.

Solution:
This is similar to the behavior discussed in the other article. The Navisworks screen refresh happens when the UI message loop delivers a paint event. If you have some code running that sits in a loop doing lots of work then there’s no way for the UI message loop to deliver a paint event.

I have practiced the way of Idle event. i.e. put your series of moves in the event. The following codes simulates a transformation: first move the selection along X+ with some distances, next rotate the objects along the axis (origin: center of the bundingbox; vector: 0,0,1). Finally, move the object along Z+ with some distances.

#region HelloWorld

 

using System;

using System.Collections.Generic;

using System.Windows.Forms;

using System.Text;

 

//Add two new namespaces

using Autodesk.Navisworks.Api;

using Autodesk.Navisworks.Api.Plugins;

 

 

namespace BasicPlugIn

{

[PluginAttribute("BasicPlugIn.ABasicPlugin",                   //Plugin name

                "ADSK",                                       //4 character Developer ID or GUID

                ToolTip = "BasicPlugIn.ABasicPlugin tool tip",//The tooltip for the item in the ribbon

                DisplayName = "Hello World Plugin")]          //Display name for the Plugin in the Ribbon

 

publicclassABasicPlugin : AddInPlugin                        //Derives from AddInPlugin

{

 

    publicoverrideint Execute(paramsstring[] parameters)

    {

        Document doc =

            Autodesk.Navisworks.Api.Application.MainDocument;

 

        // current selection

        ModelItemCollection coll =

            doc.CurrentSelection.SelectedItems;

        if (coll.Count == 0)

        {

            MessageBox.Show("no selection!");

                return 0;

        }

 

        m_Index = 0;

        //delagate the event of Idle

        Autodesk.Navisworks.Api.Application.Idle +=

                newEventHandler<EventArgs>(Idle_EventHandler);

 

        return 0;

    }

 

 

    //simulation index

    int m_Index = 0;

   

    //move step

    double oMoveStep = 2;

    //rotate step

    double oRotateStep = 0.1;

 

 

    void Idle_EventHandler(object sender, EventArgs e)

    {

 

        //get handle of Navisworks window

        IntPtr hWnd =

            Autodesk.Navisworks.Api.Application.Gui.MainWindow.Handle;

 

        if (m_Index < 50)

        {

            if (m_Index <= 15)

            {

                // move X+

                moveObjAlongX();

            }

            if (m_Index <= 30 && m_Index > 15)

            {

                //rotate the axis that (0,0,1) and

                //origin is the center of the

                //boundingbox of the collection

                rotateObjAlongAxis();

            }

 

            if (m_Index <= 50 && m_Index > 30)

            {

                // move Z+

                moveObjAlongZ();

            }

            m_Index++;

        }

        else

        {

            //stop the event Idle

            Autodesk.Navisworks.Api.Application.Idle -=

                Idle_EventHandler;

 

        }

 

    }

 

 

 

    #region "transform object"

 

    privatevoid moveObjAlongX()

    {

 

        Document doc =

            Autodesk.Navisworks.Api.Application.MainDocument;

 

        // current selection

        ModelItemCollection coll =

            doc.CurrentSelection.SelectedItems;

        if (coll.Count == 0)

            return;

 

        //build a vector for moving

        Vector3D oNewVector3d =

            newVector3D(oMoveStep, 0, 0);

 

        //create a transform from a matrix with a vector.

        Transform3D oNewOverrideTrans =

            Transform3D.CreateTranslation(oNewVector3d);

 

        doc.Models.OverridePermanentTransform(coll,

            oNewOverrideTrans,

            true); 

 

    }

 

    privatevoid rotateObjAlongAxis()

    {

 

        Document doc =

            Autodesk.Navisworks.Api.Application.MainDocument;

 

        // current selection

        ModelItemCollection coll =

            doc.CurrentSelection.SelectedItems;

        if (coll.Count == 0)

            return;

 

        //build the translation from boundingbox center to origin of WCS

        Point3D oCenterP =

            coll.BoundingBox().Center;

        Vector3D oMoveBackToOrig =

            newVector3D(-oCenterP.X, -oCenterP.Y, -oCenterP.Z);

        Transform3D oMoveBackToOrigM =

            Transform3D.CreateTranslation(oMoveBackToOrig);

 

 

        //  set the axis we will rotate around （0,0,1）

        UnitVector3D odeltaA =

            newUnitVector3D(0, 0, 1);

        // Create delta of Quaternion: axis is Z,      

        Rotation3D delta =

            newRotation3D(odeltaA, oRotateStep);

        

        //create a transform from a matrix with a rotation.

        Transform3D oNewOverrideTrans =

            newTransform3D(delta);

 

        //build final matrix

        Transform3D oFinalM =

            Transform3D.Multiply(oMoveBackToOrigM, oNewOverrideTrans);

        oFinalM =

            Transform3D.Multiply(oFinalM, oMoveBackToOrigM.Inverse());

 

        doc.Models.OverridePermanentTransform(coll, oFinalM, true);

 

    }

 

    privatevoid moveObjAlongZ()

    {

 

        Document doc =

            Autodesk.Navisworks.Api.Application.MainDocument;

 

        // current selection

        ModelItemCollection coll =

            doc.CurrentSelection.SelectedItems;

        if (coll.Count == 0)

            return;

 

        //build a vector for moving along X+

        Vector3D oNewVector3d =

            newVector3D(0,0 ,oMoveStep);

 

        Matrix3 oNewIndentityM =

            newMatrix3();

 

        //create a transform from a matrix with a vector.

        Transform3D oNewOverrideTrans =

            newTransform3D(oNewIndentityM, oNewVector3d);

 

        doc.Models.OverridePermanentTransform(coll,

            oNewOverrideTrans,

            true);

 

    }

    #endregion

 

}

}

#endregion

 

 

Navisworks Exchange Store Opens!

By Xiaodong Liang

This is a little late news because Navisworks Exchange Store has opened for some weeks :-) We have seen a bunch of downloading with the published Apps so far. I believe some developers have already known about it and are eager to submit their applications soon.

If you are not familiar with Autodesk Exchange Apps you might want to visit Exchange Store to get an idea of all the current offerings and possibilities for you. The stores serve all customer types whether they need plug-ins, standalone applications, content libraries, utilities, training material or other products that can help them in their daily work.

Exchange Apps has proven to be the most effective way for app publishers to get exposure to Autodesk customers.  It is a safe and easy way for customers to find the tools they need for their work. Exchange Apps is growing – there are more than 1,000 apps and in 2013 there were over a million unique visitors to Exchange Apps, and 334,000 unique downloads. It is a global opportunity and community with stores in 14 languages. Autodesk is implementing several features to support the sale of apps – volume sales, term/subscription based sales, web services, and purchase orders.

The Knowledge Base includes the requirements of each product and the detail tutorial on submission process.

Navisworks Manage/ Simulate 2015 and onward support Apps delivered by Autodesk Exchange. Apps can be used to add both.NET API plugins and NWcreate plugins. Information for Navisworks app developers can help you to get started with.

We are looking forward to seeing your App on the shelf !

 

Where is Navisworks 2015 SDK ?

By Xiaodong Liang

The same to last year, the SDK was not packaged with product . It is an independent installer which is now available at ADN Open . You can also download it directly from the link below:

Navisworks 2015 SDK

In default, if you have installed Navisworks 2015, the installer will be deployed <Navisworks Installation Path>\api\, same as previous. If you have not installed Navisworks 2015, it will be deployed to <My Documents>\Autodesk\Navisworks 2015\api\. You can also put  the SDK to any folder you like.

There is not much new with the SDK. But for API, the biggest change is the legacy Presenter rendering engine is removed from Navisworks 2015. This results in the loss of some API capability for automating materials assignments and materials definition. The removal of Presenter will also result in the loss of the ‘Rich Photorealistic Content’ capability and Presenter rules for automating the assignment of object materials.

In addition, both X86 and X64 installers and merge modules for ActiveX Redistributable control of 2015 are provided at \api\COM\bin.

AVR Glass - Autodesk Virtual Reality Glass In The Age of Cloud

By Xiaodong Liang

For several years now, Autodesk has been expanding its portfolio of cloud services in various industries with products such as BIM 360, Fusion 360 etc. These are the next-generation solutions for 3D CAD and corresponding industries. However, today came the surprise announcement that Autodesk has released its FIRST wearable hardware – AVR Glass: Autodesk Virtual Reality Glass! It allows you to design in virtual reality! AVR is similar to Google Glass, but focuses on CAD industry. And it's marketed in different styles at a bargain price of only $268 (Google Glass explorer 2.0 is $335).

 

 

AVR is easy to use. Just take your AVR glass into a quiet room and be seated. Put on the AVR glass, and switch on the power. When the countdown on the screen shows the internet is connected, raise one hand ahead of the Kinect Sensor and make a fist. The AVR glass will log in to Autodesk 360. Your design session has started. You can choose the industry you want to enter by simply clicking the virtual menu on your left. For example, if architecture, the glass will bring you to a virtual environment as if you are standing on a real building construction site. You can even choose a real site which links the modeling environment with Google Earth and Google Maps.

You can “see” the construction elements (steel beam, concrete beam, brick etc) available nearby. Don’t try to move towards them - just point to the element you need with your finger, wave your hand with a gesture “grab”, and the element will come to your side. Grab the elements and put them in the place you want. The workflow is just like you do on your monitor with Revit - but now you’re doing it in a virtual 3D world. If your eyes focus on one element for more than 3 seconds, its properties information will appear. You can wave your hand ahead of the Kinect Sensor to wipe it out. In the first version, grabbing more than two elements at one time will cause some lag. Our AVR boffins are working on the issue, but since you only have two hands, a maximum of two elements shouldn’t be too limiting. You have also the choice to resize the dimensions of the elements or orbit until it meets the location you want. Simply grab the element, rotate and resize.

 

Of course, an action recorder is provided. It can repeat what you did, in order to save time on repetitive construction tasks. The action recorder will also form the basis of a future collaboration with Cyberdyne Systems – a well known manufacturer of autonomous robotic systems. Actions recorded through AVR can be downloaded to a robot at the construction site, who will actually construct the building using the actions you have recorded.

AVR glass also supports collaboration which will make it invaluable to large enterprises where multiple designers collaborate together from feedback from our Beta testers indicates that collaboration is the most popular feature of AVR glass – particularly when positioning very heavy elements.

However, remember when using AVR glass for extended periods that virtual life doesn’t just consumes virtual energy, but real ’neural energy’. Two hours is the recommended maximum time spent in a single design session.

Where can you buy the glass! It is available in Autodesk Exchange Store (Yes - the Store now sells hardware!). To mark its launch, there is a huge discount (50%) today only (April 1st).

P.s. Thank Stephen for his nice editing, like robot, boffin (reminds me of cute puffins!), etc. I am complete ready to buy one tomorrow.