Finding an Exit Path and ElementId Parameter Values

As usual, lots of exciting discussions are being conducted in the Revit API discussion forum.

I'll just highlight two of them going on right now:

Finding a Path Through the BIM

First, an issue raised by Terry on how to extract points of areas for pathfinding algorithm:

Question: I want to find shortest safety path from any room to the exit in Revit.

Thus, I plan to divide areas (like rooms, exit, floor, doors) into two-dimensional grids to form vertex or nodes, so that I can apply them in a pathfinding algorithm like A*.

Astar progress animation

By Subh83 – Own work, CC BY-SA 3.0, Link

I noticed that Revit has provided coordinates in floats number which cannot be used directly, though. Is there some similar functionality which can achieve my plan in Revit API?

Answer: Regarding tips about handling the Revit floating point coordinates: That is pretty trivial. I suggest that you convert them to millimetres, store those in integer numbers, and base your calculations on that. Then you can convert the results back to the Revit imperial coordinates when needed.

The path finding aspect is much more interesting and challenging, of course.

I implemented a Revit add-in that prompts the user to select a model curve representing the optimal exit path for a specific project of Kean Walmsley's.

That is not what you are asking for, but might help with inspiration or other aspects of your task.

Do you know what a Voronoi diagram is?

It might be used to generate the optimal path automatically.

Check out Max Thumfart's sample using the C++ Boost library Voronoi implementation in a Revit add-in.

Furthermore, I heard that Adam Sheather presented an example of wrapping the A* algorithm in a Dynamo node at AU 2016; I don't see it mentioned in his class material SD21181-L – Coding New Nodes with Dynamo, though.

The A* C# library code you can use is another faster version of A* (2D+3D) in C# by Roy T.

You can use the geometry library in Dynamo or C# to check whether Revit elements intersect with the A* voxel space and use that to blank out that area.

With that in hand, you can specify a box and how many items you want to check against for the pathfinding.

You could implement code to generate Revit elements to do the intersection test in a temporary transaction and roll that back instead of committing.

However, it is probably more efficient to retrieve read-only element geometry from Revit elements with no transaction at all, and you could use the BooleanOperationsUtils.ExecuteBooleanOperation method to check for intersections.

Response: Thank you very much for your reply! The A* for 3D in C# is of great help in my future work.

I also found another simple path algorithm using dynamo which extracts points in grid, and a Dynamo package called lunch box would find the shortest: Fire Exit Risk Assessment with Revit and Dynamo.

It will give much inspiration for the pathfinding algorithm.

Finding all Possible ElementId Values for a Specific Parameter

Let's add to that yet another one of Fair59's growing list of impressive solutions, in the thread on an elegant way to get possible ElementId values for specific Parameter:

Question: I'm creating a sort of "Property Editor" dialog for user selected elements. In my dialog, the user may pick from a list of non-read-only parameters, and specify an alternate value that my application will use later on under particular circumstances (see dialog image below).

The challenge is to provide a list of relevant alternate "Element Id Values" based on the selected parameter. So far, my approach is to explicitly exam the "Current Value (ElementId)" of selected parameter and create alternate value list accordingly. For some "Current Values" I use the GetSimilarTypes function, while others I simply filter the document for elements of same category, cf. the image and code below.

So far, I have two questions:

Possible ElementId parameter values

  if( request == EditPropertyOptRequest.GetAvailableValues )
  {
    cond.SelElemValue = null;
    cond.PropertyOpt.ElementValues = new ObservableCollection<Element>();

    try
    {
      dynamic CurrentElem = doc.GetElement( cond.SelProperty.AsElementId );

      if( ( CurrentElem ) is WallType )
      {
        WallType obj = CurrentElem;

        foreachvoid ElemId_loopVariable in obj.GetSimilarTypes )
        {
          ElemId = ElemId_loopVariable;
          cond.PropertyOpt.ElementValues.Add( doc.GetElement( ElemId ) );
        }
      }
      else if( ( CurrentElem ) is FloorType )
      {
        FloorType obj = CurrentElem;

        foreachvoid ElemId_loopVariable in obj.GetSimilarTypes )
        {
          ElemId = ElemId_loopVariable;
          cond.PropertyOpt.ElementValues.Add( doc.GetElement( ElemId ) );
        }
      }
      else if( ( CurrentElem ) is FamilySymbol )
      {
        FamilySymbol obj = CurrentElem;

        foreachvoid ElemId_loopVariable in obj.GetSimilarTypes )
        {
          ElemId = ElemId_loopVariable;
          cond.PropertyOpt.ElementValues.Add( doc.GetElement( ElemId ) );
        }
      }
      else if( ( CurrentElem ) is Level )
      {
        FilteredElementCollector collector = new FilteredElementCollector( doc );
        collector.OfCategory( BuiltInCategory.OST_Levels ).WhereElementIsNotElementType();

        foreachvoid elem_loopVariable in collector )
        {
          elem = elem_loopVariable;
          cond.PropertyOpt.ElementValues.Add( elem );
        }
      }
      else if( ( CurrentElem ) is Phase )
      {
        FilteredElementCollector collector = new FilteredElementCollector( doc );
        collector.OfCategory( BuiltInCategory.OST_Phases ).WhereElementIsNotElementType();

        foreachvoid elem_loopVariable in collector )
        {
          elem = elem_loopVariable;
          cond.PropertyOpt.ElementValues.Add( elem );
        }
      }
      cond.SelElemValue = cond.PropertyOpt.ElementValues( 0 );
    }
    catchException ex )
    {
    }
  }

Quick update...

After realizing GetSimilarTypes method is inherited from the ElementType base class, I now attempt to cast Element to ElementType, then use GetSimilarTypes method if ElemType is Not NULL. Otherwise I filter document for NonElementTypes of same Category. I still need to handle elements with No Category. So far, I've identified Line Styles as being this way.

I am quite happy with this approach!

  if( request == EditPropertyOptRequest.GetAvailableValues )
  {
    cond.SelElemValue = null;
    cond.PropertyOpt.ElementValues = new ObservableCollection<Element>();

    if( cond.SelProperty.StorageType == StorageType.ElementId )
    {
      ElementId ElemId = cond.SelProperty.AsElementId;
      if( ElemId == null )
        return;

      Element Elem = doc.GetElement( ElemId );
      ElementType ElemType = Elem as ElementType;

      if( ElemType != null )
      {
        foreach( ElemId in ElemType.GetSimilarTypes )
        {
          cond.PropertyOpt.ElementValues.Add( doc.GetElement( ElemId ) );
        }
      }
      else if( Elem.Category != null )
      {
        FilteredElementCollector collector = new FilteredElementCollector( doc );
        collector.OfCategory( Elem.Category.Id.IntegerValue ).WhereElementIsNotElementType();

        foreach( Elem in collector )
        {
          cond.PropertyOpt.ElementValues.Add( Elem );
        }
      }
      else
      {
        //
        // Handle non-category elements. Namely Line Styles(aka GraphicStlyes)
        //
      }

      cond.SelElemValue = cond.PropertyOpt.ElementValues( 0 );
    }
  }

This differs significantly from the combo box dropdown workarounds, because it touches on how to mimic contextual content of the Element Properties Panel using Revit API; more specifically, how to get a list of available ElementId values for a given Parameter whose Storage Type = ElementId and has an existing value to use as reference. Mostly revolving around use of 'ElementType.GetSimilarTypes' method.

To get available values for a parameter that does not have an existing value for reference, you might be able to create a suitable template element in a temporary transaction, grab the data you require from it, and roll back the transaction without committing, also known as the 'temporary transaction trick' TTT.

Even then, I don't see a way to determine what a "suitable template element" might be. Given a parameter with ElementID value, the only helpful information looks like BuiltInParameter Id, but that doesn't get me very far. Worst case, I make exceptions for my favourite BuiltInParameter Id's to assist in determining "suitable template element".

Almost as if the Parameter class would benefit from something like a GetSampleValueType method.

Answer: You can use an ElementParameterFilter to get all the elements that have a value other than ElementId.InvalidElementId for a specific parameter.

This code filters for elements in the active view that are demolished in some phase:

  ParameterValueProvider pvp_Demolished 
    = new ParameterValueProvider( 
      new ElementId( (intBuiltInParameter
        .PHASE_DEMOLISHED ) );

  FilterNumericGreater fgreater 
    = new FilterNumericGreater();

  FilterElementIdRule IdFilter 
    = new FilterElementIdRule( pvp_Demolished, 
      fgreater, ElementId.InvalidElementId );

  ElementParameterFilter efilter 
    = new ElementParameterFilter( IdFilter );

  FilteredElementCollector elems 
    = new FilteredElementCollector( 
      doc, doc.ActiveView.Id )
        .WherePasses( efilter );

Response: Unfortunately that's not what I'm looking to accomplish. Please see the video below for a better explanation of what I'm trying to do:

Maybe you might have another idea.

Answer: Actually, it is part of what you are trying to accomplish. With an ElementParameterFilter, you get a list of elements (if there are any) that have a value for the parameter in question, and then you may find all the relevant values, or display all the found values.

Response: Oh, I see now, VERY CLEVER!!!

Just implemented and works like a charm. Only caveat like you say is "if there are any", but I can live with that.

Thanks for the great tip!!!

Many thanks again to Fair59 for all his exciting solutions!