AEC DevBlog

RevitAPI: How to create wall sweep?

中文链接

By Aaron Lu

Wall Sweep's API class is WallSweep, but there is no method like NewWallSweep under Document.Create object, so how to create it via API?

The answer is using static method Create of WallSweep:

public static WallSweep Create(Wall wall, ElementId wallSweepType, WallSweepInfo wallSweepInfo);

Code example:

var doc = commandData.Application.ActiveUIDocument.Document;
var uiSel = commandData.Application.ActiveUIDocument.Selection;

try
{
    var reference = uiSel.PickObject(Autodesk.Revit.UI.Selection.ObjectType.Element, "Pick wall");
    var wall = doc.GetElement(reference) as Wall;
    ElementType wallSweepType = new FilteredElementCollector(doc)
        .OfCategory(BuiltInCategory.OST_Cornices)
        .WhereElementIsElementType()
        .Cast().FirstOrDefault();
    if (wallSweepType != null)
    {
        var wallSweepInfo = new WallSweepInfo(WallSweepType.Sweep, false);
        wallSweepInfo.Distance = 2;
        using (Transaction transaction = new Transaction(doc))
        {
            transaction.Start("create wall sweep");
            WallSweep.Create(wall, wallSweepType.Id, wallSweepInfo);
            transaction.Commit();
        }
    }
    else
    {
        TaskDialog.Show("ERROR", "no wall sweep type is found");
    }
}
catch (Autodesk.Revit.Exceptions.OperationCanceledException)
{
}

1. First, pick a wall as the host
2. then filter out all the wallsweep type and choose the first one
3. create the argument object WallSweepInfo by calling the constructor of WallSweepInfo, note that we can continue to customize it by setting its properties, e.g. in this example, by calling 'wallSweepInfo.Distance = 2' to set the distance of the wall sweep to the bottom of the hosted wall
4. Finally, call WallSweep.Create function to create the wall sweep

 

RevitAPI: how to get point clouds?

中文链接

By Aaron Lu

From Revit > Insert > Point Cloud, we can insert point clouds into Revit, then how to get those points information via API?

Inspect with RevitLookup, we found the inserted point cloud is an object of class PointCloudInstance, and there is a method named GetPoints, which is what we want.

 

GetPoints() has 3 arguments

public PointCollection GetPoints(
PointCloudFilter filter, double averageDistance, int numPoints);

filter specifies the conditions for filtering points.

averageDistance stands for minimal distance between points, the smaller, the more points we will get.

numPoints stands for the maximum number of points to be returned.

The key is how to create the filter, there is no constructor of class PointCloudFilter, no static Create function, and no relative creation functions under Document.Create nor Application.Create, fortunately, we found method CreateMultiPlaneFilter in class PointCloudFilterFactory.

public static PointCloudFilter CreateMultiPlaneFilter(IList<Autodesk.Revit.DB.Plane> planes);
public static PointCloudFilter CreateMultiPlaneFilter(IList<Autodesk.Revit.DB.Plane> planes, int exactPlaneCount);

planes: defines a set of planes, all points returned should be in the positive direction of those planes, so we can use those planes to define a range to include all the points, and the range can be non-closure.

exactPlaneCount: Exact number of planes to match. The greater, the more accurate (meaning less points are outside of the range defined by planes), the slower of the searching speed. If not specified, it is default to the number of first argument: planes.

Below example shows how to filter out points inside a box:

if (pointCloudInstance != null)
{
    int SIZE = 100;
    List<Plane> planes = new List<Plane>();
    var min = new XYZ(-SIZE,-SIZE, -SIZE);
    var max = new XYZ(SIZE, SIZE, SIZE);

    //x planes
    planes.Add(new Plane(XYZ.BasisX, min));
    planes.Add(new Plane(-XYZ.BasisX, max));

    //y planes
    planes.Add(new Plane(XYZ.BasisY, min));
    planes.Add(new Plane(-XYZ.BasisY, max));

    //z planes
    planes.Add(new Plane(XYZ.BasisZ, min));
    planes.Add(new Plane(-XYZ.BasisZ, max));

    PointCloudFilter pcf = PointCloudFilterFactory.CreateMultiPlaneFilter(planes);
    var points = pointCloudInstance.GetPoints(pcf, 1, 100000);
}

 

RevitAPI: how to find code examples for macro of python or ruby?

中文链接

By Aaron Lu

One of the new features of Revit 2016 API is that Revit now supports macro written in Python or Ruby.

But there is no Python or Ruby code examples in Revit 2016 SDK. So how to get started? Well, most of people did not notice that the code examples are hidden in the default macro projects created by macro manager, see below image, the project is the default python project, there are several "if False" statements, if you remove the line of "if False", uncomment and unindent 4 spaces to methods below it, the methods will become available macros and appear in the macro manager, and you will see the same "if false" in Ruby projects too:

RevitAPI: Document.ExportImage exports some .jpg files when setting ImageFileType set to PNG

中文链接

By Aaron Lu

Image export feature is available in RevitAPI, that is: Document.ExportImage method, a real example is:

FilteredElementCollector FEC_Views = new FilteredElementCollector(OpenDoc).OfClass(typeof(View));
FEC_Views.OfCategory(BuiltInCategory.OST_Views);
StringBuilder sb = new StringBuilder();
foreach (View View in FEC_Views)
{
    if (View.IsTemplate) continue;
    IList<ElementId> ImageExportList = new List<ElementId>();
    ImageExportList.Clear();
    ImageExportList.Add(View.Id);
    var NewViewName = View.Name.ToString().Replace(".", "-");
    var BilledeExportOptions_3D_PNG = new ImageExportOptions
    {
        ZoomType = ZoomFitType.FitToPage,
        PixelSize = 2024,
        FilePath = ParentFolder + @"\" + NewViewName,
        FitDirection = FitDirectionType.Horizontal,
        HLRandWFViewsFileType = ImageFileType.PNG,
        ImageResolution = ImageResolution.DPI_600,
        ExportRange = ExportRange.SetOfViews,
    };

    BilledeExportOptions_3D_PNG.SetViewsAndSheets(ImageExportList);
    try
    {
        OpenDoc.ExportImage(BilledeExportOptions_3D_PNG);
    }
    catch (Exception ex)
    {
        sb.AppendLine(View.Id.ToString());
        sb.AppendLine(ex.ToString());
    }
}

This program can export all the exportable views into .png file.

In general, there is no problem, but for some special revit files, it will export some .jpg files as well, why that happens even if we set the exporting format to .png using HLRandWFViewsFileType = ImageFileType.PNG?

The reason is: ImageExportOptions has different settings for two types of views: (1) hidden line and wireframe (HLRandWFViewsFileType property) and (2) shadow views (ShadowViewsFileType property), so we have to set ShadowViewsFileType to .png as well, then the problem got solved

    var BilledeExportOptions_3D_PNG = new ImageExportOptions
    {
        ZoomType = ZoomFitType.FitToPage,
        PixelSize = 2024,
        FilePath = ParentFolder + @"\" + NewViewName,
        FitDirection = FitDirectionType.Horizontal,
        HLRandWFViewsFileType = ImageFileType.PNG,
        ShadowViewsFileType = ImageFileType.PNG,
        ImageResolution = ImageResolution.DPI_600,
        ExportRange = ExportRange.SetOfViews,
    };

 

RevitAPI: how to change Radius of ConnectorElement? - how to get associated family parameter from element parameter?

中文链接

By Aaron Lu

Connector Element of some fitting family has a parameter named "Radius", to change its value, we may write code like this:

connectorElement.Radius = 0.041;

But Radius property is read-only, so it can not be compiled or even it can be, exception will be thrown when running it.

Another way is using Parameter:

var radiusPara = connectorElement.get_Parameter(BuiltInParameter.CONNECTOR_RADIUS);
radiusPara.Set(0.041);

But radiusPara here is also read-only (radiusPara.IsReadOnly == true), exception will be thrown too.

As we know that radius is not changeable in UI, rather, we need to change the associated family parameter, e.g. in this case, "Normal Radius"

Then the question is how to get the associated family parameter?

Following code shows the answer:

var sb = new StringBuilder();
foreach (var connectorPara in connectorElement.GetOrderedParameters())
{
    foreach (FamilyParameter familyPara in doc.FamilyManager.Parameters)
    {
        foreach (Parameter associatedPara in familyPara.AssociatedParameters)
        {
            if (connectorPara.Id == associatedPara.Id && associatedPara.Element.Id == connectorElement.Id)
            {
                //associate parameter found
                sb.AppendLine("'" + associatedPara.Definition.Name + 
                    "(" + (BuiltInParameter)associatedPara.Id.IntegerValue + 
                    ")' <-> '" + familyPara.Definition.Name + "'");
            }
        }
    }
}
TaskDialog td = new TaskDialog("Parameter associations");
td.MainContent = sb.ToString();
td.TitleAutoPrefix = false;
td.Show();

It will display all parameter associations between ConnectorElement parameters and family parameters, let's see what it does:

1. Use GetOrderedParameters() to get all parameters of connectorElement, iterate each parameter,
2. Use Document.FamilyManager.Parameters to get all FamilyParameters, iterate each family parameter,
3. Use FamilyParameter.AssociatedParameters to get all assocated parameters of elements in the document,
4. Iterate all associated parameters, check whether the parameter of connector element is the same as the associated parameter, and they belong to the same element.

Below is the result:

For now, it is clear on how to change radius:

1. Find the associated family parameter
2. Set the family parameter using Document.FamilyManager.Set(familyParameter, value)

complete code is shown as below:

var doc = commandData.Application.ActiveUIDocument.Document;
var uiSel = commandData.Application.ActiveUIDocument.Selection;
ConnectorElement connectorElement = null;
try
{
    var reference = uiSel.PickObject(Autodesk.Revit.UI.Selection.ObjectType.Element, "Pick a connector");
    connectorElement = doc.GetElement(reference) as ConnectorElement;

    if (connectorElement != null)
    {
        var radiusPara = connectorElement.get_Parameter(BuiltInParameter.CONNECTOR_RADIUS);
        foreach (FamilyParameter familyPara in doc.FamilyManager.Parameters)
        {
            foreach (Parameter associatedPara in familyPara.AssociatedParameters)
            {
                if (radiusPara.Id == associatedPara.Id && associatedPara.Element.Id == connectorElement.Id)
                {
                    //associate parameter found
                    using (Transaction transaction = new Transaction(doc))
                    {
                        transaction.Start("Set Radius");
                        doc.FamilyManager.Set(familyPara, 0.041);
                        transaction.Commit();
                    }
                }
            }
        }
    }
}
catch (Autodesk.Revit.Exceptions.OperationCanceledException)
{
}

 

RevitAPI: how to get Graphic Display Options

中文链接

By Aaron Lu

Several customers is asking how to get Graphic Display Options from Revit API, after my investigation, I found API did not expose all available information in UI, what are available is shown in below picture, makred with 1,2,3:

Related methods are:

ViewDisplayModel displayModel = view.GetViewDisplayModel(); //1
ViewDisplaySketchyLines sketchyLines = view.GetSketchyLines(); //2
SunAndShadowSettings sunAndShadowSettings = view.SunAndShadowSettings; //3

 

RevitAPI: Revit 2016 Events register/unregister behavior change

中文链接

By Aaron Lu

In previous Revit version, we can register/unregister an event in a modeless dialog, but now Revit 2016 changed the behavior of Events, it is no longer allowed to do so, otherwise exception will be thrown, if that exception is not caught by your application, Revit may crash.

Revit 2016 API changes document says:

API events - behavioral change

Although the Revit API has never officially supported such a work-flow it is now enforced that registering to and unregistering from events must happen while executing on the main thread. An exception will be thrown if an external application attempts to register to (or unregister from) events from outside of valid API context.

The solutions can be:

• Use model dialog, or make sure you register/unregister events in the Execute function of IExternalCommand or OnStartup/OnShutdown function of IExternalApplication.
• If you must use modeless dialog, you can use ExternalEvent.Raise() method, force the context switch to Revit main thread, and in the corresponding Execute method of IExternalEventHandler, register/unregister your events.

 

Code examples

First, have a class implementing IExternalEventHandler, and in its Execute method, register a event, e.g. Application.DocumentChanged.

public class EventRegisterHandler : IExternalEventHandler
{
    public void Execute(UIApplication app)
    {
        app.Application.DocumentChanged += Application_DocumentChanged;
    }

    void Application_DocumentChanged(object sender, Autodesk.Revit.DB.Events.DocumentChangedEventArgs e)
    {
        // do your stuff
    }

    public string GetName()
    {
        return "EventRegisterHandler";
    }
}

When you want to make it happen, just create an instance of ExternalEvent, and call its Raise() method. e.g. in a modeless dialog, clicking a button to cause the registration of the event DocumentChanged. Code:

private void button1_Click(object sender, EventArgs e)
{
    ExternalEvent _exEvent = null;
    EventRegisterHandler _exEventHandler = null;
    _exEventHandler = new EventRegisterHandler();
    _exEvent = ExternalEvent.Create(_exEventHandler);
    _exEvent.Raise();
}

Edited on 2016/3/8

Someone found the above code "ExternalEvent.Create" method throws Autodesk.Revit.Exceptions.InvalidOperationException: Attempting to create an ExternalEvent outside of a standard API execution, that is a true bug in my code, sorry for that :-(. And the solution is easy: do not call "ExternalEvent.Create" in modeless dialog but in "IExternalCommand.Execute" or "IExternalApplication.OnStartup". Following is a full code example showing that: Run ExternalCommand "EventRegistrationInModelessDialogViaExternalEvent" and then click the button in the modeless dialog to register or unregister DocumentChanged event. 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Autodesk.Revit.ApplicationServices;
using Autodesk.Revit.Attributes;
using Autodesk.Revit.DB;
using Autodesk.Revit.UI;
using System.Windows.Forms;

namespace TestScript
{
    [TransactionAttribute(TransactionMode.Manual)]
    public class EventRegistrationInModelessDialogViaExternalEvent 
        : IExternalCommand
    {
        public Document doc;
        public Autodesk.Revit.ApplicationServices.Application RevitApp;
        ExternalEvent _exEvent;
        public Result Execute(ExternalCommandData commandData, ref string message, ElementSet elements)
        {
            EventRegisterHandler _exeventHander = new EventRegisterHandler();
            _exEvent = ExternalEvent.Create(_exeventHander);
            MyForm form = new MyForm();
            form.ExEvent = _exEvent;
            form.Show();

            return Result.Succeeded;
        }
    }

    public class MyForm : System.Windows.Forms.Form
    {
        public MyForm()
            : base()
        {
            Button btn = new Button();
            btn.Text = "Toggle DocumentChanged Event Registration";
            btn.Click += btn_Click;
            btn.Width = 250;
            this.Controls.Add(btn);
        }

        public ExternalEvent ExEvent { get; set; }

        void btn_Click(object sender, EventArgs e)
        {
            if (ExEvent != null)
                ExEvent.Raise();
            else
                MessageBox.Show("external event handler is null");
        }
    }

    public class EventRegisterHandler : IExternalEventHandler
    {
        public bool EventRegistered { get; set; }
        public void Execute(UIApplication app)
        {
            if (EventRegistered)
            {
                EventRegistered = false;
                app.Application.DocumentChanged -= Application_DocumentChanged;
            }
            else
            {
                EventRegistered = true;
                app.Application.DocumentChanged += Application_DocumentChanged;
            }
        }

        void Application_DocumentChanged(object sender, 
            Autodesk.Revit.DB.Events.DocumentChangedEventArgs e)
        {
            var sb = new StringBuilder();
            var added = "added:" + e.GetAddedElementIds()
                .Aggregate("", (ss, el) => ss + "," + el).TrimStart(',');
            var modified = "modified:" + e.GetModifiedElementIds()
                .Aggregate("", (ss, el) => ss + "," + el).TrimStart(',');
            var deleted = "deleted:" + e.GetDeletedElementIds()
                .Aggregate("", (ss, el) => ss + "," + el).TrimStart(',');
            sb.AppendLine(added);
            sb.AppendLine(modified);
            sb.AppendLine(deleted);
            TaskDialog.Show("Changes", sb.ToString());
        }

        public string GetName()
        {
            return "EventRegisterHandler";
        }
    }
}

RevitAPI: How to get location of keynote file?

中文链接

By Aaron Lu

After a research, I found location of keynote file is hidden deeply

KeynoteTable.GetKeynoteTable(Document).GetExternalResourceReferences() returns a dictionary, from which we can get object of ExternalResourceReference, then using ExternalResourceReference.InSessionPath we could get its file location.

RevitAPI: Close active document

中文链接

By Aaron Lu

In the forum, customer said he wants to close the active document and reopen it, he took the suggestion from Jeremy's blog, and had some events related questions, though I did not totally understand yet :(

 

As we know, to close document, we can use UIDocument.SaveAndClose() or Document.Close(), however, if the document is active, we got an InvalidOperationException: The active document may not be closed from the API.

So we need to use something else, Jeremy mentioned one way by sending "Ctrl+F4" message to Revit, i.e.:

 SendKeys.SendWait( "^{F4}" );

Another way is, open and activate a placeholder document, and then close the original one, that's what the customer tried to do, and it works. To summary what the article is about, I used a shorter code snippet:

var placeholderFile = @"C:\placeholder.rvt";
var doc = commandData.Application.ActiveUIDocument.Document;
var file = doc.PathName;
var docPlaceholder = commandData.Application.OpenAndActivateDocument(placeholderFile);
doc.Close(false);
var uidoc = commandData.Application.OpenAndActivateDocument(file);
docPlaceholder.Document.Close(false);

Steps:

• Open and active the placeholder document
• Close the doc
• Open and activate the doc
• Close the placeholder document

So, we don't need any events for now :)

 

RevitAPI: FamilyManager.Set - InvalidOperationException and get members from AssemblyInstance

中文链接

By Aaron Lu

Q: Would you please confirm it is not allowed to set value family parameter if there is no type?

In Family Editor, when calling FamillyManager.Set(FamilyParameter), it will throw InvalidOperationException: There is no current type

the code looks like this:

var para = RevitDoc.FamilyManager.AddParameter("Length", BuiltInParameterGroup.INVALID, ParameterType.Length, false);
RevitDoc.FamilyManager.Set(para, 123.1);

It allows us to create "parameter" without any types, but not able to set value of parameters, because it should be meanless to set a parameter which is not belong to any type.

So, we should check if FamilyManager.CurrentType is null or not before calling ".Set" method.

if (familyMgr.CurrentType == null)
    familyMgr.NewType("A new type");
var para = familyMgr.AddParameter("Length", BuiltInParameterGroup.INVALID, ParameterType.Length, false);
RevitDoc.FamilyManager.Set(para, 123.1);

Q: How to get elements which are part of a selected assembly?

As you may have already tried that RevitLookup did not show useful information of parts in an assembly you selected, but when you look at the methods of AssemblyInstance, you will see a set of methods related with its parts:

• ICollection GetMemberIds();
• void AddMemberIds(ICollection memberIds);
• void RemoveMemberIds(ICollection memberIds);
• void SetMemberIds(ICollection memberIds);

those methods allows to:

• Get members of the assembly
• Add more members into the assembly
• Remove a set of members
• Set a list of elements as its members

so easy now, use GetMemberIds()