dtk_RevitReader.hpp

Go to the documentation of this file.

/**********************************************************
   Dtk_RevitReader.hpp
***********************************************************/
#ifndef _DTK_REVIT_READER_HPP_
#define _DTK_REVIT_READER_HPP_
#include "util/dtk_reader.hpp"
#include "def/define.h"
 
class RevitReader: public Dtk_Reader
{
protected :
public :
     enum class LevelOfDetail
     {
          ReaderGuessed = 0,
          Coarse = 1,
          Medium = 2,
          Detailed = 3
     };
     enum class VisualStyle
     {
          ReaderGuessed = 0,
          Shaded = 1,
          Textures = 2,
          Realistic = 3
     };
     virtual ~RevitReader() = 0;
     static Dtk_bool Enable();
     //! [Options]
     //! \brief Determine which Revit visual style to use for convertion. The visual style determines which material color to apply on objects with material. See Autodesk documentation on Revit Visual Styles for detailed information. 
     //! \param  The desired visual style to use for convertion.
     //! \warning please call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     //! \remark VisualStyle::Realistic usage toggles the retrieving of texture information.
     //! \remark Texture files are searched in current folder and default Autodesk installation folder.
     static void SetConfigRevitVisualStyle( VisualStyle );
 
     //! \brief Use to render as in revit "Realistic" and "Texture" visual style for views (with textures). By default, texture reading is disabled (as in "Shaded" style).
     //! \param DTK_TRUE to render texture or DTK_FALSE otherwise.
     //! \warning please call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     //! \remark Texture files are searched in current folder and default Autodesk installation folder
     //! \deprecated Use SetConfigRevitVisualStyle( VisualStyle ) instead.
     SetAsDeprecated( "2025.4", "Use SetConfigRevitVisualStyle( VisualStyle ) instead." )
     static void SetConfigRevitRealisticView( Dtk_bool );
 
     //! \brief Use to able/disable reading of Revit properties. By default, properties reading is enabled.
     //! \param DTK_TRUE to read Revit properties or DTK_FALSE otherwise.
     //! \warning please call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     //! \deprecated Metadata are now always retrieved..
     SetAsDeprecated( "2025.4", "Metadata are now always retrieved." )
     static void SetConfigRevitReadMetadata( Dtk_bool );
 
     //! \brief Use to able/disable reading of Revit 3d views. By default, view reading is enabled.
     //! \param DTK_TRUE to read Revit views or DTK_FALSE otherwise.
     //! \warning please call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     //! \deprecated Views are now always retrieved.
     SetAsDeprecated( "2025.4", "Views are now always retrieved." )
     static void SetConfigRevitReadViews( Dtk_bool );
 
     //! \brief Use to provide the same component organization as IFC or a flat one. By default, components are organized as in IFC.
     //! \param DTK_TRUE to organize component as IFC (by Building, Level and element Category) or DTK_FALSE for flat organization.
     //! \warning please call it after Dtk_API initialization and before the Dtk_API::OpenDocument call.
     static void SetConfigRevitOrderCompo( Dtk_Int32 );
 
     //! \brief Use to retrieve only geometry corresponding to a specific level of detail. By default, level of detail retrieved is the one set in default view ({3D}) or "Detailed" if no default view exists.
     //! \param The desired level of detail to be retrieved for geometry.
     //! \warning If no geometry is assigned to the level of detail chosen, the Body/Mesh contained in the node converted will be empty.
     static void SetConfigLevelOfDetail( LevelOfDetail );   
 
     //! \brief Use to enables reading of Revit Linked Models, which file should be located in the same folder as the main project.
     //! \param DTK_TRUE to enables the feature, DTK_FALSE to only process the main model.
     static void SetConfigReadLinkedModel( Dtk_bool );
     //! [Options]
} ;
 
#endif //#ifndef _DTK_REVIT_READER_HPP_