// // (C) Copyright 2003-2023 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.Windows.Forms; using Autodesk.Revit.DB; using Autodesk.Revit.UI; using TaskDialog = Autodesk.Revit.UI.TaskDialog; namespace Revit.SDK.Samples.SlabProperties.CS { /// /// Get some properties of a slab , such as Level, Type name, Span direction, /// Material name, Thickness, and Young Modulus for the slab's Material. /// [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 { #region Class constant variables const double PI = 3.1415926535879; const int Degree = 180; const int ToMillimeter = 1000; const double ToMetricThickness = 0.3048; // unit for changing inch to meter const double ToMetricYoungmodulus = 304800.0; #endregion #region Class member variables ElementSet m_slabComponent; // the selected Slab component Floor m_slabFloor; // Floor CompoundStructureLayer m_slabLayer; // Structure Layer System.Collections.Generic.IList m_slabLayerCollection; // Structure Layer collection Document m_document; string m_level; // level name of Slab string m_typeName; // type name of Slab string m_spanDirection; // span direction (degree) of Slab string m_thickness; // thickness (millimeter) of slab layer string m_materialName; // material name of slab layer string m_youngModulusX; // Young modulus X string m_youngModulusY; // Young modulus Y string m_youngModulusZ; // Young modulus Z int m_numberOfLayers; // number of Structure Layers #endregion #region Interface implementation /// /// 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, Autodesk.Revit.DB.ElementSet elements) { Autodesk.Revit.UI.UIApplication revit = commandData.Application; try { // function initialization and find out a slab's Level, Type name, and set the Span Direction properties. bool isInitialization = this.Initialize(revit); if (false == isInitialization) { return Autodesk.Revit.UI.Result.Failed; } // show a displayForm to display the properties of the slab SlabPropertiesForm slabForm = new SlabPropertiesForm(this); if (DialogResult.OK != slabForm.ShowDialog()) { return Autodesk.Revit.UI.Result.Cancelled; } } catch (Exception displayProblem) { TaskDialog.Show("Revit", displayProblem.ToString()); return Autodesk.Revit.UI.Result.Failed; } return Autodesk.Revit.UI.Result.Succeeded; } #endregion #region Class propertied /// /// Level property, read only. /// public string Level { get { return m_level; } } /// /// TypeName property, read only. /// public string TypeName { get { return m_typeName; } } /// /// SpanDirection property, read only. /// public string SpanDirection { get { return m_spanDirection; } } /// /// NumberOfLayers property, read only. /// public int NumberOfLayers { get { return m_numberOfLayers; } } /// /// LayerThickness property, read only. /// public string LayerThickness { get { return m_thickness; } } /// /// LayerMaterialName property, read only. /// public string LayerMaterialName { get { return m_materialName; } } /// /// LayerYoungModulusX property, read only. /// public string LayerYoungModulusX { get { return m_youngModulusX; } } /// /// LayerYoungModulusY property, read only. /// public string LayerYoungModulusY { get { return m_youngModulusY; } } /// /// LayerYoungModulusZ property, read only. /// public string LayerYoungModulusZ { get { return m_youngModulusZ; } } #endregion #region Public class method /// /// SetLayer method /// /// The layerNumber for the number of the layers public void SetLayer(int layerNumber) { // Get each layer. // An individual layer can be accessed by Layers property and its thickness and material can then be reported. m_slabLayer = m_slabLayerCollection[layerNumber]; // Get the Thickness property and change to the metric millimeter m_thickness = ((m_slabLayer.Width) * ToMetricThickness * ToMillimeter).ToString() + " mm"; // Get the Material name property if (ElementId.InvalidElementId != m_slabLayer.MaterialId) { Material material = m_document.GetElement(m_slabLayer.MaterialId) as Material; m_materialName = material.Name; } else { m_materialName = "Null"; } // The Young modulus can be found from the material by using the following generic parameters: // PHY_MATERIAL_PARAM_YOUNG_MOD1, PHY_MATERIAL_PARAM_YOUNG_MOD2, PHY_MATERIAL_PARAM_YOUNG_MOD3 if (ElementId.InvalidElementId != m_slabLayer.MaterialId) { Material material = m_document.GetElement(m_slabLayer.MaterialId) as Material; Parameter youngModuleAttribute = null; youngModuleAttribute = material.get_Parameter(BuiltInParameter.PHY_MATERIAL_PARAM_YOUNG_MOD1); if (null != youngModuleAttribute) { m_youngModulusX = (youngModuleAttribute.AsDouble() / ToMetricYoungmodulus).ToString("F2") + " MPa"; } youngModuleAttribute = material.get_Parameter(BuiltInParameter.PHY_MATERIAL_PARAM_YOUNG_MOD2); if (null != youngModuleAttribute) { m_youngModulusY = (youngModuleAttribute.AsDouble() / ToMetricYoungmodulus).ToString("F2") + " MPa"; } youngModuleAttribute = material.get_Parameter(BuiltInParameter.PHY_MATERIAL_PARAM_YOUNG_MOD3); if (null != youngModuleAttribute) { m_youngModulusZ = (youngModuleAttribute.AsDouble() / ToMetricYoungmodulus).ToString("F2") + " MPa"; } } else { m_youngModulusX = "Null"; m_youngModulusY = "Null"; m_youngModulusZ = "Null"; } } #endregion #region Private class memeber methods /// /// Initialization and find out a slab's Level, Type name, and set the Span Direction properties. /// /// The revit object for the active instance of Autodesk Revit. /// A value that signifies if your initialization was successful for true or failed for false. private bool Initialize(Autodesk.Revit.UI.UIApplication revit) { m_slabComponent = new ElementSet(); foreach (ElementId elementId in revit.ActiveUIDocument.Selection.GetElementIds()) { m_slabComponent.Insert(revit.ActiveUIDocument.Document.GetElement(elementId)); } m_document = revit.ActiveUIDocument.Document; // There must be exactly one slab selected if (m_slabComponent.IsEmpty) { // nothing selected TaskDialog.Show("Revit", "Please select a slab."); return false; } else if (1 != m_slabComponent.Size) { // too many things selected TaskDialog.Show("Revit", "Please select only one slab."); return false; } foreach (Element e in m_slabComponent) { // If the element isn't a slab, give the message and return failure. // Else find out its Level, Type name, and set the Span Direction properties. if ("Autodesk.Revit.DB.Floor" != e.GetType().ToString()) { TaskDialog.Show("Revit", "A slab should be selected."); return false; } // Change the element type to floor type m_slabFloor = e as Floor; // Get the layer information from the type object by using the CompoundStructure property // The Layers property is then used to retrieve all the layers m_slabLayerCollection = m_slabFloor.FloorType.GetCompoundStructure().GetLayers(); m_numberOfLayers = m_slabLayerCollection.Count; // Get the Level property by the floor's Level property m_level = (m_document.GetElement(m_slabFloor.LevelId) as Level).Name; // Get the Type name property by the floor's FloorType property m_typeName = m_slabFloor.FloorType.Name; // The span direction can be found using generic parameter access // using the built in parameter FLOOR_PARAM_SPAN_DIRECTION Parameter spanDirectionAttribute; spanDirectionAttribute = m_slabFloor.get_Parameter(BuiltInParameter.FLOOR_PARAM_SPAN_DIRECTION); if (null != spanDirectionAttribute) { // Set the Span Direction property this.SetSpanDirection(spanDirectionAttribute.AsDouble()); } } return true; } /// /// Set SpanDirection property to the class private member /// Because of the property retrieved from the parameter uses radian for unit, we should change it to degree. /// /// The value of span direction property private void SetSpanDirection(double spanDirection) { double spanDirectionDegree; // Change "radian" to "degree". spanDirectionDegree = spanDirection / PI * Degree; // If the absolute value very small, we consider it to be zero if (Math.Abs(spanDirectionDegree) < 1E-12) { spanDirectionDegree = 0.0; } // The precision is 0.01, and unit is "degree". m_spanDirection = spanDirectionDegree.ToString("F2"); } #endregion } }