ugw.hpp

Go to the documentation of this file.

/**********************************************************
UGW.H
***********************************************************/
#ifndef _UGW_H
#define _UGW_H
 
#define DTK_UGW_VERSION_NX5             45
#define DTK_UGW_VERSION_NX1980          60
#define DTK_UGW_VERSION_NX2212          63
 
namespace Ugw
{
     struct DefaultParameters
     {
          enum Unit
          {
               inch = 0, millimeters = 1
          };
          Unit unit;
          bool asm_multithread;
          struct ModelingPreferences
          {
               double distance_tolerance;
               double angle_tolerance;
               double density;
               enum DensityUnit 
               {
                    lb_in3=1,lb_ft3=2,g_m3=3,kg_m3=4
               };
               DensityUnit density_unit;
               ModelingPreferences() :distance_tolerance( 0.001 ), angle_tolerance( 0.5 ),
                    density( 7830.640 ), density_unit( kg_m3 )
               {}
          };
          ModelingPreferences modelingpreferences;
          Dtk_RGB background_color_top, background_color_bottom;
          struct ObjectPreferences
          {
               struct General
               {
                    Dtk_RGB col;
                    Dtk_Double64 width;
                    General():width(0.35) {} // or default (-1)
               };
               General def,solid_body,sheet_body;
               ObjectPreferences()
               {
                    def.col = Dtk_RGB( 0, 0, 192 );
                    def.width = 0.70;
               }
          };
          ObjectPreferences objectpreferences;
 
          DefaultParameters() :unit( millimeters ), asm_multithread(false), background_color_top(Dtk_RGB(150,190,220)), 
               background_color_bottom( Dtk_RGB( 230, 230, 230 ) )
          {}
     };
 
     //! \ingroup UG_write
     //! \brief Initialize UG Writer.
     //! \param [in] inFilename : Name of output file to write.
     //! \param [in] inVersiontowrite : Version to write, only UGW_VERSION_NX5 available for now
     //! \param [in] inDef : Default datas
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus InitFile( const Dtk_string& inFilename, int inVersiontowrite = DTK_UGW_VERSION_NX5, const DefaultParameters& inDef = DefaultParameters() );
 
     //! Deprecated
     Dtk_ErrorStatus InitFile( const Dtk_string& inFilename,
          int inVersiontowrite, int inUnitasmm, int inMultithread = 0 );
 
 
     //! \ingroup UG_write
     //! \brief Add a body inside the file.
     //! \param [in] inBody : Body to add.
     //! \remark Body Infos->AddAttribute("NXGROUPS",chain) to set groups, see example.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus WriteBody(const Dtk_BodyPtr& inBody);
 
     //! \ingroup UG_write
     //! \brief Add a mesh inside the file.
     //! \param [in] inMesh : Mesh to add.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus WriteMesh(const Dtk_MeshPtr& inMesh);
 
     
     //! \ingroup UG_write
     //! \brief Add a pmi inside the file.
     //! \param [in] inPmi : Pmi to add.
     //! \remark Actually just some annotations are supported, see documentation
     //! \return dtkNoError if ok, dtkErrorCannotCompute if not supported Pmi
     Dtk_ErrorStatus WritePMI(const Dtk_FdtPtr& inPmi);
 
     //! \ingroup UG_write
     //! \brief Add an axis system into the current node.
     //! \param [in] inAxisSystem : axis system to Write.
     //! \remark, in info field, SetName to set FeatureName, AddAttribute("NXNAME") to set the object name
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus WriteAxisSystem(const Dtk_AxisSystemPtr& inAxisSystem);
 
     //! \ingroup UG_write
     //! \brief Add a reference geometry into the current node.
     //! \remark Stored is a body as one face with plane for reference plane, trimmed reference plane for fixed reference plane, wire segment for reference axis, wire point for reference point
     //! \param [in] inRefgeom : reference geometry to Write.
     //! \remark, in info field, SetName to set FeatureName, AddAttribute("NXNAME") to set the object name
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus WriteReferenceGeometry(const Dtk_BodyPtr& inRefgeom);
 
     //! \ingroup UG_write
     //! \brief Add a MetaData in the current component
     //! \param [in] inMeta : Metadata to add.
     //! \remark Special Metadatas with Category = "Modeling Preferences"
     //! \remark Title = "Distance Tolerance" & Value = tolerance in mm
     //! \remark Title = "Angle Tolerance" & Value = tolerance in degree
     //! \remark Title = "Density" & Value = Density
     //! \remark Title = "Density Units" & Value = "lb/in3" or "lb/ft3" or "g/m3" or "kg/m3"
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddMetaData(const Dtk_MetaDataPtr& inMeta);
 
     //! \ingroup UG_write
     //! \brief deprecated
     Dtk_ErrorStatus OpenInstance(const Dtk_string& inInstanceName,
                                         const Dtk_string& inProtoFileName,
                                         Dtk_bool& outWasAlreadyInstancied,
                                         const Dtk_transfo& inTrans,
                                         const Dtk_RGB& inRgb);
     //! \ingroup UG_write
     //! \brief Open an child instance to write an assembly
     //! \param [in] inProtoFileName : Prototypename, also file name : for a subassembly reinstancied, this name must be the same for all instances
     //! \param [in] inTrans : Matrix of this instance. Dtk_transfo() for identity Matrix
     //! \param [in] inInfos : Additional informations, see options supported
     //! \remark inInfos->SetName(InstanceName) to give an instance name (default instance has same name as part)
     //! \remark inInfos->SetColor(Dtk_Rgb) to give an instance color
     //! \remark inInfos->SetBlankedStatus(1) to set component as invisible
     //! \remark inInfos->SetLayer(l) to set a specific component layer
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus OpenInstance(const Dtk_string& inProtoFileName,
          const Dtk_transfo& inTrans,   Dtk_InfoPtr inInfos);
 
     //! \ingroup UG_write
     //! \brief Open an extern file to add as instance in current assembly, inProtoFileName must be in the output directory. Just give name without path and extension
     //! \param [in] inProtoFileName : Prototypename, also file name : for a subassembly reinstancied, this name must be the same for all instances
     //! \param [in] inTrans : Matrix of this instance. Dtk_transfo() for identity Matrix
     //! \param [in] inInfos : Additional informations, see options supported; same as OpenInstance
     //! \param [in] innxread_getdata : Function nxread_getdata of Datakit NXReader, retrieving subassemblies from extern, can be NULL.
     Dtk_ErrorStatus AddExternInstance(const Dtk_string& inProtoFileName,
          const Dtk_transfo& inTrans, Dtk_InfoPtr inInfos, void(*innxread_getdata)(const Dtk_string&, void*&));
 
     //! \ingroup UG_write
     //! \brief Get color value and color name from the palette
     //! \param [in] inIth : Color index, from 0 (background) to 216 (max color index)
     //! \param [out] outColor : Color to retrieve
     //! \param [out] outColorname : Color name to retrieve
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus GetColorInTable(size_t inIth, Dtk_RGB& outColor, Dtk_string& outColorname);
 
     //! \ingroup UG_write
     //! \brief Replace color value and color name on the palette
     //! \param [in] inIth : Color index, from 0 (background) to 216 included (max color index)
     //! \param [in] inColor : Color to set
     //! \param [in] inColorname : Color name to set
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus SetColorInTable(size_t inIth, const Dtk_RGB& inColor, const Dtk_string& inColorname);
 
     //! \ingroup UG_write
     //! \brief Import a color palette
     //! \param [in] InCdfFile : Cdf file to import
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus ImportCdfColorfile(const Dtk_string& InCdfFile);
 
     //! \ingroup UG_write
     //! \brief define Data for layers
     //! \param [in] inLayerDataSet : LayerDataSet, see example
     //! \remark default visibles and selectables
     Dtk_ErrorStatus SetLayerData(const Dtk_LayerInfosSetPtr& inLayerDataSet, const Dtk_tab<Dtk_Int32> & unused1 = Dtk_tab<Dtk_Int32>(), 
          const Dtk_tab<Dtk_Int32> & unused2 = Dtk_tab<Dtk_Int32>());
 
     //! \remark Deprecated, use SetGroupDatas
     Dtk_ErrorStatus SetGroupVisibility(const Dtk_string& inGroupName, Dtk_bool  inVisible);
 
     //! \ingroup UG_write
     //! \brief define Visibility for a specific group
     //! \param [in] inGroupName : Name of group
     //! \param [in] inInfos : Additional informations, see options supported
     //! \remark inInfos->SetBlankedStatus(1) to set component as invisible
     //! \remark inInfos->SetLayer(l) to set a specific component layer
     //! \remark inInfos->AddAttribute("NXGROUPS",chain) create an empty group, see example
     Dtk_ErrorStatus SetGroupDatas(const Dtk_string& inGroupName, Dtk_InfoPtr inInfos);
 
     //! \ingroup UG_write
     //! \brief Add a Parasolid file as body inside the file.
     //! \param [in] inFlux : Raw parasolid file to add.
     //! \param [in] inSize : Size of flux.
     //! \param [in] inInf  : Additionnal informations. (name, visibility, default colors)
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus WriteExternParasolidBody(const char* inFlux, size_t inSize, const Dtk_InfoPtr& inInf);
 
     //! \ingroup UG_write
     //! \brief Add a JT file as lightweight body inside the file.
     //! \param [in] inFlux : Raw JT file to add.
     //! \param [in] inSize : Size of flux.
     //! \param [in] inInf  : Additionnal informations. (name, visibility, default colors)
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus WriteExternJtMesh(const char* inFlux, size_t inSize, const Dtk_InfoPtr& inInf);
 
     //! \ingroup UG_write
     //! \brief Close the last instance
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus CloseLastInstance();
 
     //! \ingroup UG_write.
     //! \brief Close the UG file.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus EndFile();
 
}
 
#endif