RevitSdkSamples/SDK/Samples/VisibilityControl/CS/VisibilityCtrl.cs

//
// (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;

using Autodesk.Revit.DB;

namespace Revit.SDK.Samples.VisibilityControl.CS
{
    /// <summary>
    /// An enumerate type listing the types of element select mode.
    /// </summary>
    public enum IsolateMode
    {
        None,
        PickOne,
        WindowSelect
    }

    /// <summary>
    /// An object control visibility by category
    /// </summary>
    public class VisibilityCtrl
    {
        private Autodesk.Revit.UI.UIDocument m_document;    // the active document
        private Hashtable m_allCategories; // all categories name with its visibility
        private Hashtable m_categoriesWithName; // all categories with its name
        private IsolateMode m_isolateMode;  // the mode to select element(s)
        
        /// <summary>
        /// get all categories name with its visibility
        /// </summary>
        public Hashtable AllCategories
        {
            get
            {
                return m_allCategories;
            }
        }

        /// <summary>
        /// get and set the mode to select element(s)
        /// </summary>
        public IsolateMode IsolateMode
        {
            get
            {
                return m_isolateMode;
            }
            set
            {
                m_isolateMode = value;
            }
        }

        /// <summary>
        /// Default constructor
        /// </summary>
        /// <remarks>get all categories of this document. check its visibility for 
        /// the active document, and initialize a hashtable.</remarks>
        public VisibilityCtrl(Autodesk.Revit.UI.UIDocument document)
        {
            if (null == document)
            {
                throw new ArgumentNullException("document");
            }
            else
            {
                m_document = document;
            }

            // initialize the two table
            m_allCategories = new Hashtable();
            m_categoriesWithName = new Hashtable();

            // fill out the two table
            foreach (Category category in m_document.Document.Settings.Categories)
            {
                if(category.get_AllowsVisibilityControl(m_document.Document.ActiveView))
                {
                    m_allCategories.Add(category.Name, category.get_Visible(m_document.Document.ActiveView));
                    m_categoriesWithName.Add(category.Name, category);
                }                
            }
        }

        /// <summary>
        /// Set the visibility for the active view
        /// </summary>
        /// <returns>Return true if operation successed, or else, return false.</returns>
        public bool SetVisibility(bool visible, string name)
        {
            try
            {
                Category cat = m_categoriesWithName[name] as Category;                
                m_document.Document.ActiveView.SetCategoryHidden(cat.Id, !visible);
                //or cat.set_Visible(m_document.ActiveView, visible);
                m_allCategories[cat.Name] = visible;
            }
            catch (Exception)
            {
                return false;
            }

            return true;
        }

        /// <summary>
        /// Isolate elements with the same categories that the selected elements belong to
        /// using PickOne or WindowSelect.
        /// </summary>
        public void Isolate()
        {
            //m_document.Selection.Elements.Clear();
            System.Collections.Generic.ICollection<Reference> elements = null;
            switch (m_isolateMode)
            {
                case IsolateMode.PickOne: 
                    // One more element will be added to modscope 
                    // if user really selects an element which differs from the elements in 
                    // modscope before user's pick one operation.
                    elements.Add(m_document.Selection.PickObject(Autodesk.Revit.UI.Selection.ObjectType.Element));
                    break;
                case IsolateMode.WindowSelect:
                    // Elements will be added to modscope if possilbe.
                    elements = m_document.Selection.PickObjects(Autodesk.Revit.UI.Selection.ObjectType.Element);
                    break;
                default:
                    break;
            }

            // ElementSet elements = m_document.Selection.Elements;

            // hide all categories elements
            foreach (Category cat in m_document.Document.Settings.Categories)
            {
                SetVisibility(false, cat.Name);
            }

            // set the visibility for the selection elements
            foreach (Reference reference in elements)
            {
                Category cat = m_document.Document.GetElement(reference).Category;
                if (null != cat && !string.IsNullOrEmpty(cat.Name))
                {
                    SetVisibility(true, cat.Name);
                }
            }
        }
    }
}