RevitSdkSamples/snapshot/2008/SDK/Samples/CreateDimensions/CS/Command.cs

//
// (C) Copyright 2003-2007 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.IO;
using System.Collections;
using System.Windows.Forms;
using System.Collections.Generic;
using System.Text;

using Autodesk;
using Autodesk.Revit;
using Autodesk.Revit.Elements;
using Autodesk.Revit.Geometry;
using Autodesk.Revit.Structural;
using Autodesk.Revit.Symbols;
using Autodesk.Revit.Parameters;


namespace Revit.SDK.Samples.CreateDimensions.CS
{
    /// <summary>
    /// Implements the Revit add-in interface IExternalCommand
    /// </summary>
    public class Command : IExternalCommand
    {
        ExternalCommandData m_revit = null;    //store external command
        string m_errorMessage = " ";           // store error message
        ArrayList m_walls = new ArrayList();   //store the wall of selected
        static int m_count = 0;                      //store the sequence number of new dimesion  
        const double precision = 0.0000001;         //store the precision   

        /// <summary>
        /// Implement this method as an external command for Revit.
        /// </summary>
        /// <param name="commandData">An object that is passed to the external application 
        /// which contains data related to the command, 
        /// such as the application object and active view.</param>
        /// <param name="message">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.</param>
        /// <param name="elements">A set of elements to which the external application 
        /// can add elements that are to be highlighted in case of failure or cancellation.</param>
        /// <returns>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.</returns>
        public IExternalCommand.Result Execute(ExternalCommandData revit, ref string message, ElementSet elements)
        {
            try
            {
                m_revit = revit;
                Autodesk.Revit.Elements.View view = m_revit.Application.ActiveDocument.ActiveView;
                View3D view3D = view as View3D;
                if (null != view3D)
                {
                    message += "Only create dimensions in 2D";
                    return IExternalCommand.Result.Failed;
                }

                ViewSheet viewSheet = view as ViewSheet;
                if (null != viewSheet)
                {
                    message += "Only create dimensions in 2D";
                    return IExternalCommand.Result.Failed;
                }

                //try too adds a dimension from the start of the wall to the end of the wall into the project
                if (!AddDimension())
                {
                    message = m_errorMessage;
                    return IExternalCommand.Result.Failed;
                }
                return IExternalCommand.Result.Succeeded;
            }
            catch (Exception e)
            {
                message = e.Message;
                return IExternalCommand.Result.Failed;
            }            
        }

        /// <summary>
        /// find out the wall, insert it into a array list
        /// </summary>
        bool initialize()
        {
            ElementSet selections = m_revit.Application.ActiveDocument.Selection.Elements;
            //nothing was selected
            if (0 == selections.Size)
            {
                m_errorMessage += "Please select Basic walls";
                return false;
            }

            //find out wall
            foreach (Autodesk.Revit.Element e in selections)
            {
                Wall wall = e as Wall;
                if (null != wall)
                {
                    if( WallType.WallKind.Basic != wall.WallType.Kind ) // jeremy
                    {
                        continue;
                    }
                    m_walls.Add(wall);
                }
            }

            //no wall was selected
            if (0 == m_walls.Count)
            {
                m_errorMessage += "Please select Basic walls";
                return false;
            }
            return true;
        }

        /// <summary>
        /// find out every wall in the selection and add a dimension from the start of the wall to its end
        /// </summary>
        /// <returns>if add successfully, true will be retured, else false will be returned</returns>
        public bool AddDimension()
        {
            if (!initialize())
            {
                return false;
            }

            //get out all the walls in this array, and create a dimension from its start to its end
            for (int i = 0; i < m_walls.Count; i++)
            {
                Wall wall = m_walls[i] as Wall;
                if (null == wall)
                {
                    continue;
                }

                //get loction curve
                Location location = wall.Location;
                LocationCurve locationline = location as LocationCurve;
                if (null == locationline)
                {
                    continue;
                }

                //New Line
                XYZ locationEndPoint = locationline.Curve.get_EndPoint(1);
                XYZ locationStartPoint = locationline.Curve.get_EndPoint(0);
                Line newLine = m_revit.Application.Create.NewLine(ref locationStartPoint,
                                                                  ref locationEndPoint,
                                                                  true);

                //get reference
                ReferenceArray referenceArray = new ReferenceArray();

                Options options = m_revit.Application.Create.NewGeometryOptions();
                options.ComputeReferences = true;
                options.View = m_revit.Application.ActiveDocument.ActiveView;
                Autodesk.Revit.Geometry.Element element = wall.get_Geometry(options);
                GeometryObjectArray geoObjectArray = element.Objects;
                //enum the geometry element
                for( int j = 0; j < geoObjectArray.Size; ++j )
                {
                    GeometryObject geoObject = geoObjectArray.get_Item(j);
                    Curve curve = geoObject as Curve;
                    if (null != curve)
                    {
                        //find the two upright lines beside the line
                        if (Validate(newLine, curve as Line))
                        {
                            referenceArray.Append(curve.Reference);
                        }

                        if (2 == referenceArray.Size)
                        {
                            break;
                        }
                    }
                }
                try
                {
                    //try to new a dimension
                    bool isExist = false;
                    Autodesk.Revit.Application app = m_revit.Application;
                    Document doc = app.ActiveDocument;
                    XYZ p1 = newLine.get_EndPoint(0);
                    p1.X += 5;
                    p1.Y += 5;
                    XYZ p2 = newLine.get_EndPoint(1);
                    p2.X += 5;
                    p2.Y += 5;
                    Line newLine2 = app.Create.NewLine(ref p1, ref p2, true);
                    Dimension newDimension = doc.Create.NewDimension(
                      doc.ActiveView, newLine2, referenceArray);

                    if (null != newDimension)
                    {
                        m_count++;
                        string name = "Dimension " + m_count.ToString();

                        //set it into the property dialog
                        ParameterSet attributes = newDimension.Parameters;
                        foreach (Parameter pa in attributes)
                        {
                            if ("Dimension Name" == pa.Definition.Name)
                            {
                                isExist = true;
                                pa.Set(name);
                            }
                        }
                        //if it does not exist a parameter named Name, create it
                        if (!isExist)
                        {
                            AddParameterToDimesion();
                            ParameterSet attributeSet = newDimension.Parameters;
                            foreach (Parameter pa in attributeSet)
                            {
                                if ("Dimension Name" == pa.Definition.Name)
                                {
                                    pa.Set(name);
                                }
                            }

                        }
                    }
                }
                // catch the exceptions
                catch (Exception ex)
                {
                    m_errorMessage += ex.ToString();
                    return false;
                }
            }
            return true;
        }

        /// <summary>
        /// make sure the line we get from the its geometry is upright to the location line 
        /// </summary>
        /// <param name="line1">the first line</param>
        /// <param name="line2">the second line</param>
        /// <returns>if the two line is upright, true will be retured</returns>
        bool Validate(Line line1, Line line2)
        {
            //if it is not a linear line
            if (null == line1 || null == line2)
            {
                return false;
            }

            //get the first line's length
            XYZ newLine = new XYZ(line1.get_EndPoint(1).X - line1.get_EndPoint(0).X,
                                 line1.get_EndPoint(1).Y - line1.get_EndPoint(0).Y,
                                 line1.get_EndPoint(1).Z - line1.get_EndPoint(0).Z);
            double x1 = newLine.X * newLine.X;
            double y1 = newLine.Y * newLine.Y;
            double z1 = newLine.Z * newLine.Z;
            double sqrt1 = Math.Sqrt(x1 + y1 + z1);

            //get the second line's length
            XYZ vTemp = new XYZ(line2.get_EndPoint(1).X - line2.get_EndPoint(0).X,
                                line2.get_EndPoint(1).Y - line2.get_EndPoint(0).Y,
                                line2.get_EndPoint(1).Z - line2.get_EndPoint(0).Z);
            double x2 = vTemp.X * vTemp.X;
            double y2 = vTemp.Y * vTemp.Y;
            double z2 = vTemp.Z * vTemp.Z;
            double sqrt2 = Math.Sqrt(x1 + y1 + z1);

            double VP = newLine.X * vTemp.X + newLine.Y * vTemp.Y + newLine.Z * vTemp.Z;
            double compare = VP / (sqrt1 * sqrt2);
            if ((-precision <= compare) && (precision >= compare))
            {
                return true;
            }
            return false;
        }

        /// <summary>
        /// access to the share parameter, if it does not exist, create it.
        /// </summary>
        /// <returns>if open the shares parameter file successfully, the file will be returned, 
        /// else null will be returned</returns>
        DefinitionFile AccesstoSharedParametersFile()
        {
            //return the result
            DefinitionFile sharedFile = null;

            //get the position of the file
            //string document = m_revit.Application.Options.SharedParametersFilename;
            string currentPath = System.Windows.Forms.Application.ExecutablePath;
            string sharedParameterFile = Path.GetDirectoryName(currentPath);
            sharedParameterFile = sharedParameterFile + "\\MySharedParameters.txt";

            // Check if the file is exist,Create file for external shared parameter if it does not exist
            System.IO.FileInfo documentMessage = new FileInfo(sharedParameterFile);
            bool fileExist = documentMessage.Exists;
            if (!fileExist)
            {
                FileStream fileFlow = File.Create(sharedParameterFile);
                fileFlow.Close();
            }

            // Set the new file to  the externalsharedParameterFile 
            m_revit.Application.Options.SharedParametersFilename = sharedParameterFile;
            sharedFile = m_revit.Application.OpenSharedParameterFile();
            return sharedFile;
        }

        /// <summary>
        /// add a dimesion named Name to dimension object
        /// </summary>
        void AddParameterToDimesion()
        {
            // access the shared parameters file
            DefinitionFile sharedFile = AccesstoSharedParametersFile();
            if (null == sharedFile)
            {
                return;
            }

            // Access an existing group, if doesn't exist,create a new one in the shared parameters file
            DefinitionGroups definitionCollections = sharedFile.Groups;
            DefinitionGroup definitionGroup = null;
            definitionGroup = definitionCollections.get_Item("MyParameter");
            if (null == definitionGroup)
            {
                definitionCollections.Create("MyParameter");
                definitionGroup = definitionCollections.get_Item("MyParameter");
            }

            // Access existing or create new external parameter definitions  belong to the specific group
            Definition dimensionName = definitionGroup.Definitions.get_Item("Dimension Name");
            if (null == dimensionName)
            {
                // create new external parameter definitions "Dimension Name"
                definitionGroup.Definitions.Create("Dimension Name",
                                                   Autodesk.Revit.Parameters.ParameterType.Text, true);
                dimensionName = definitionGroup.Definitions.get_Item("Dimension Name");
            }

            // Create a new Binding object with the categories to which the parameters will be bound
            CategorySet categories = m_revit.Application.Create.NewCategorySet();
            Category dimensionNameCategory = null;
            dimensionNameCategory = m_revit.Application.ActiveDocument.Settings.Categories.get_Item
                                    (BuiltInCategory.OST_Dimensions);
            categories.Insert(dimensionNameCategory);
            InstanceBinding bindingInstance = m_revit.Application.Create.NewInstanceBinding(categories);

            // Add the binding and definition to the document
            m_revit.Application.ActiveDocument.ParameterBindings.Insert(dimensionName, bindingInstance);
        }
    }
}