// // (C) Copyright 2003-2019 by Autodesk, Inc. // // Permission to use, copy, modify, and distribute this software in // object code form for any purpose and without fee is hereby granted, // provided that the above copyright notice appears in all copies and // that both that copyright notice and the limited warranty and // restricted rights notice below appear in all supporting // documentation. // // AUTODESK PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. // AUTODESK SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF // MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. AUTODESK, INC. // DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE // UNINTERRUPTED OR ERROR FREE. // // Use, duplication, or disclosure by the U.S. Government is subject to // restrictions set forth in FAR 52.227-19 (Commercial Computer // Software - Restricted Rights) and DFAR 252.227-7013(c)(1)(ii) // (Rights in Technical Data and Computer Software), as applicable. // using System; using System.Collections.Generic; using System.Text; using Autodesk.Revit; using Autodesk.Revit.DB; using Autodesk.Revit.UI; using Autodesk.Revit.DB.Structure; namespace Revit.SDK.Samples.DeckProperties.CS { /// /// Implements the Revit add-in interface IExternalCommand /// [Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.Manual)] [Autodesk.Revit.Attributes.Regeneration(Autodesk.Revit.Attributes.RegenerationOption.Manual)] [Autodesk.Revit.Attributes.Journaling(Autodesk.Revit.Attributes.JournalingMode.NoCommandData)] public class Command : IExternalCommand { private DeckPropertyForm m_displayForm; private Document m_document; /// /// Implement this method as an external command for Revit. /// /// An object that is passed to the external application /// which contains data related to the command, /// such as the application object and active view. /// A message that can be set by the external application /// which will be displayed if a failure or cancellation is returned by /// the external command. /// A set of elements to which the external application /// can add elements that are to be highlighted in case of failure or cancellation. /// Return the status of the external command. /// A result of Succeeded means that the API external method functioned as expected. /// Cancelled can be used to signify that the user cancelled the external operation /// at some point. Failure should be returned if the application is unable to proceed with /// the operation. public Autodesk.Revit.UI.Result Execute(Autodesk.Revit.UI.ExternalCommandData commandData, ref string message, ElementSet elements) { // Get the application of revit Autodesk.Revit.UI.UIApplication revit = commandData.Application; m_document = revit.ActiveUIDocument.Document; try { ElementSet elementSet = new ElementSet(); foreach (ElementId elementId in revit.ActiveUIDocument.Selection.GetElementIds()) { elementSet.Insert(revit.ActiveUIDocument.Document.GetElement(elementId)); } if (elementSet.IsEmpty) { TaskDialog.Show("Select", "Please select one floor or slab at least."); return Autodesk.Revit.UI.Result.Cancelled; } using (m_displayForm = new DeckPropertyForm()) { List floorList = new List(); foreach (ElementId elementId in revit.ActiveUIDocument.Selection.GetElementIds()) { Element element = revit.ActiveUIDocument.Document.GetElement(elementId); Floor floor = element as Floor; if (floor != null) { floorList.Add(floor); } } if (floorList.Count <= 0) { TaskDialog.Show("Select", "Please select one floor or slab at least."); return Autodesk.Revit.UI.Result.Cancelled; } foreach (Floor floor in floorList) { DumpSlab(floor); } m_displayForm.ShowDialog(); } } catch (Exception ex) { // If any error, store error information in message and return failed message = ex.Message; return Autodesk.Revit.UI.Result.Failed; } // If everything goes well, return succeeded. return Autodesk.Revit.UI.Result.Succeeded; } /// /// Dump the properties of interest for the slab passed as a parameter /// /// private void DumpSlab(Floor slab) { m_displayForm.WriteLine("Dumping Slab" + slab.Id.IntegerValue.ToString()); Autodesk.Revit.DB.FloorType slabType = slab.FloorType; if (slabType != null) { foreach (CompoundStructureLayer layer in slabType.GetCompoundStructure().GetLayers()) { if (layer.Function == MaterialFunctionAssignment.StructuralDeck) { DumbDeck(layer); } else { DumpLayer(layer); } } } m_displayForm.WriteLine(" "); } /// /// Dump properties specific to a decking layer /// /// private void DumbDeck(CompoundStructureLayer deck) { m_displayForm.WriteLine("Dumping Deck"); if (deck.MaterialId != ElementId.InvalidElementId) { // get the deck material object. In this sample all we need to display is the // name, but other properties are readily available from the material object. Autodesk.Revit.DB.Material deckMaterial = m_document.GetElement(deck.MaterialId) as Material; m_displayForm.WriteLine("Deck Material = " + deckMaterial.Name); } if (deck.DeckProfileId != ElementId.InvalidElementId) { // the deck profile is actually a family symbol from a family of profiles Autodesk.Revit.DB.FamilySymbol deckProfile = m_document.GetElement(deck.DeckProfileId) as FamilySymbol; // firstly display the full name as the user would see it in the user interface // this is done in the format Family.Name and then Symbol.Name m_displayForm.WriteLine("Deck Profile = " + deckProfile.Family.Name + " : " + deckProfile.Name); // the symbol object also contains parameters that describe how the deck is // specified. From these parameters an external application can generate // identical decking for analysis purposes DumpParameters(deckProfile); } } /// /// A generic parameter display method that displays all the parameters of an element /// /// private void DumpParameters(Element element) { foreach (Parameter parameter in element.Parameters) { string value = ""; switch (parameter.StorageType) { case Autodesk.Revit.DB.StorageType.Double: value = parameter.AsDouble().ToString(); break; case Autodesk.Revit.DB.StorageType.ElementId: value = parameter.AsElementId().IntegerValue.ToString(); break; case Autodesk.Revit.DB.StorageType.String: value = parameter.AsString(); break; case Autodesk.Revit.DB.StorageType.Integer: value = parameter.AsInteger().ToString(); break; } m_displayForm.WriteLine(parameter.Definition.Name + " = " + value); } } /// /// for non deck layers this method is called and it displays minimal information /// about the layer /// /// private void DumpLayer(CompoundStructureLayer layer) { // Display the name of the material. More detailed material properties can // be found form the material object m_displayForm.WriteLine("Dumping Layer"); Autodesk.Revit.DB.Material material = m_document.GetElement(layer.MaterialId) as Material; if (material != null) { m_displayForm.WriteLine("Layer material = " + material.Name); } // display the thickness of the layer in inches. m_displayForm.WriteLine("Layer Thickness = " + layer.Width.ToString()); } } }