include/opencascade/RWMesh_NameFormat.hxx

0001 // Copyright: Open CASCADE 2021
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef _RWMesh_NameFormat_HeaderFile
0015 #define _RWMesh_NameFormat_HeaderFile
0016
0017 //! Name format preference for XCAF shape labels.
0018 enum RWMesh_NameFormat
0019 {
0020   RWMesh_NameFormat_Empty,    //!< omit the name
0021   RWMesh_NameFormat_Product,  //!< return Product name
0022                               //!  (e.g. from XCAFDoc_ShapeTool::GetReferredShape(), which could be
0023                               //!  shared by multiple Instances)
0024   RWMesh_NameFormat_Instance, //!< return Instance name
0025   RWMesh_NameFormat_InstanceOrProduct,  //!< return Instance name when available and Product name
0026                                         //!< otherwise
0027   RWMesh_NameFormat_ProductOrInstance,  //!< return Product name when available and Instance name
0028                                         //!< otherwise
0029   RWMesh_NameFormat_ProductAndInstance, //!< generate "Product [Instance]" name
0030   RWMesh_NameFormat_ProductAndInstanceAndOcaf, //!< generate name combining Product+Instance+Ocaf
0031                                                //!< (useful for debugging purposes)
0032 };
0033
0034 #endif // _RWMesh_NameFormat_HeaderFile