jtw.h

Go to the documentation of this file.

#ifndef _JTW_H
#define _JTW_H
#include "def/define.h"
#include "struct/str_def.h"
#include "util/BaseTypes/dtk_metadata.hpp"
#include "util/BaseTypes/dtk_rgb.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/BaseTypes/dtk_transfo.hpp"
#include "util/dtk_maindoc.hpp"
#include "util/dtk_render.hpp"
#include "util/error_dtk.hpp"
#include "util/util_draw_ptr_dtk.hpp"
#include "util/util_ent_dtk.hpp"
#include "util/util_stl_dtk.hpp"
#include "util/util_topology_ptr_dtk.hpp"
 
//! \ingroup jtw_utils
//! \class Dtk_Jtw_Interface
//! \brief This is Jt Interface class used to write Jt files.
class Dtk_Jtw_Interface
{
public:
     enum breptype
     {
          nobrep = 0,
          xtbrep = 1,
     };
     enum colorstrategy
     {
          keepsubcolor = 0,
          overwritecolor = 1
     };
     enum writeversion
     {
          version80 = 80,
          version90 = 90,
          version91 = 91,
          version92 = 92,
          version93 = 93,
          version94 = 94,
          version95 = 95,
          version100 = 100,
          version101 = 101,
          version102 = 102,
          version103 = 103,
          version104 = 104,
          version105 = 105,
          version106 = 106,
          version107 = 107,
          version108 = 108,
          version109 = 109,
          version1010 = 1010
     };
     enum unit
     {
          millimeters = 0,
          centimeters = 1,
          meters = 2,
          inches = 3,
          feet = 4,
          yards = 5,
          micrometers = 6,
          decimeters = 7,
          kilometers = 8,
          mils = 9,
          miles = 10
     };
private:
     void* vdata;
     Dtk_Jtw_Interface(const Dtk_Jtw_Interface&) {} // uncopiable
     Dtk_Jtw_Interface& operator=(const Dtk_Jtw_Interface&) { return *this; } // uncopiable
     Dtk_string m_filename;
public:
     //! \brief Constructor, initialize the Jt Writer  
     //! \param [in] inFileWritten : File to write
     //! \param [out] outErr : Error returned. dtkNoError on success.
     //! \param [in] inBrep : Which brep should be integrated : see breptype enum. nobrep for no brep (only mesh, packed file (default)), or xtbrep : contain Parasolid Brep, need Parasolid Writer.
     //! \param [in] inVersion : Version to write : see writeversion enum, default is version95
     //! \param [in] inUnit : Unit of file, see unit enum. Default is millimeters
     Dtk_Jtw_Interface(const Dtk_string& inFileWritten, Dtk_ErrorStatus& outErr, breptype inBrep = nobrep,
          writeversion inVersion = version95, unit inUnit = millimeters);
     //! \brief Destructor, finalise the process
     ~Dtk_Jtw_Interface();
 
// TreeControl
 
     //! \brief Open a new Instance for the assembly writing.
     //! \remark Tree Contole method
     //! \brief Note that at least a node must be opened before writing a mesh.
     //! \return dtkNoError if ok.
     //! \param [in] inName : Name of the node (written in Jt2Go assembly tree)
     //! \param [in] inTrans : Local matrix of the node. Default is an identity matrix.
     //! \param [in] inExternfile : if string lengths>0, open a new file from this child, allowing multiple Jt files (shattered, perpart, percomponent, or customized)
     Dtk_ErrorStatus OpenInstance(const Dtk_string& inName, const Dtk_transfo& inTrans = Dtk_transfo(), const Dtk_string& inExternfile = Dtk_string());
     //! \brief Open a new Instance for the assembly writing.
     //! \remark Note that at least a node must be opened before writing a mesh.
     //! \remark Tree Contole method
     //! \return dtkNoError if ok.
     //! \param [in] inName : Name of the node (written in Jt2Go assembly tree)
     //! \param [in] inIdpart : ID to reinstance a part : if you give 2 times the same ID, the part is reinstancied.
     //! \param [in] inTrans : Local matrix of the node. Default is an identity matrix.
     //! \param [in] inExternfile : if string lengths>0, open a new file from this child, allowing multiple Jt files (shattered, perpart, percomponent, or customized)
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus OpenInstance(const Dtk_string& inName, Dtk_Int64 inIdpart, const Dtk_transfo& inTrans = Dtk_transfo(), const Dtk_string& inExternfile = Dtk_string());
     //! \brief Set a Color to previously opened instance
     //! \remark Tree Contole method
     //! \param [in] inRgb : Color to apply to instance.
     //! \param [in] inColorstrategy : see colorstrategy enum, with keepsubcolor color will affect only uncolored objects, overwritecolor will re-color all objects
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus LastInstance_SetInstanceColor(const Dtk_RGB& inRgb, colorstrategy inColorstrategy = keepsubcolor);
     //! \brief Set a Lightmap to previously opened instance. A lightmap is more complete that Dtk_RGB, this fonction override same fonction with Dtk_RGB
     //! \remark Tree Contole method
     //! \param [in] inLightmap : Color to apply to instance.
     //! \param [in] inColorstrategy : see colorstrategy enum, with keepsubcolor color will affect only uncolored objects, overwritecolor will re-color all objects
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus LastInstance_SetInstanceColor(const Dtk_LightMapPtr& inLightmap, colorstrategy inColorstrategy = keepsubcolor);
     //! \brief Set previously opened instance as invisible
     //! \remark Tree Contole method
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus LastInstance_SetInvisible();
     //! \brief Set an instance ID to previously opened instance
     //! \remark Tree Contole method
     //! \param [in] inInstanceID : Giving an ID to this instance if a connector needs to target a specific instance
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus LastInstance_SetInstanceID(Dtk_Int64 inInstanceID);
     //! \brief Close the last opened node.
     //! \remark Tree Contole method
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus CloseLastInstance();
     //! \brief Ask the writer if a part already exist.
     //! \remark Tree Contole method
     //! \param [in] inIdpart : ID of a part. 
     //! \return dtkNoError if ok.
     Dtk_bool ExistIdPart(Dtk_Int64 inIdpart) const;
 
// Geometry
 
     //! \brief Add a body into the current node.
     //! \remark Tesselate it to store into JT File, and add the body as brep depending inBrep parameter in constructor
     //! \remark You may give a body ID (for ConnectPMI_Geom) using inBody->info()->SetId(id)
     //! \param [in] inBody : Body to Write.
     //! \param [in] inLodDatas : couples of linear_tolerance/angular_tolerances (radian) for each LOD : so nblod = InLodDatas.size()/2. -1 value mean disabled. Empty tab = 1 LOD with (-1,-1)
     //! \param [in] inLossytol : Set lossycompression tolerance for mesh : ie move vertices with maximum tolerance value for better compression. Keep 0 for lossless comrpession
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddBody(const Dtk_BodyPtr& inToWrite, const Dtk_tab<Dtk_Float32>& makelods = Dtk_tab<Dtk_Float32>(), Dtk_Float32 inLossytol = 0);
     //! \brief Add a mesh into the current node.
     //! \param [in] inMesh : Mesh to Write.
     //! \param [in] inLossytol : Set lossycompression tolerance for mesh : ie move vertices with maximum tolerance value for better compression. Keep 0 for lossless comrpession
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddMesh(const Dtk_MeshPtr& inToWrite, Dtk_Float32 inLossytol = 0);
     //! \brief Add a Metdata into the current node.
     //! \param [in] inToWrite : MetDatas to Write.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddMetaData(const Dtk_MetaDataPtr& inToWrite);
     //! \brief Add a Layer informations.
     //! \return dtkNoError if ok.
     //! \param [in] inToWrite : Dtk_LayerInfosSetPtr to Write.
     Dtk_ErrorStatus AddLayerInfosSet(const Dtk_LayerInfosSetPtr& inToWrite);
 
// PMI
     //! \brief Add a fdt into the current node.
     //! \param [in] inPMI : PMI to Write.
     //! \param [in] inIdpmi : You may give an ID for FDT, to connect on. -1 for automatic ID.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddPMI(const Dtk_FdtPtr& inPMI, Dtk_Int64 inIdpmi = -1);
     //! \brief Add a modelView into the current node.
     //! \param [in] inModelview : modelView to Write.
     //! \param [in] inIdmodelview : You may give an ID for modelview, to connect on. -1 for automatic ID.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddModelView(const Dtk_ModelDisplayPtr& inModelview, Dtk_Int64 inIdmodelview = -1);
     //! \brief Add an axis system into the current node.
     //! \param [in] inAxisSystem : axis system to Write.
     //! \param [in] inIdaxis : You may give an ID for axis system, to connect on. -1 for automatic ID.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddAxisSystem(const Dtk_AxisSystemPtr& inAxisSystem, Dtk_Int64 inIdaxis = -1);
     //! \brief Add a reference geometry into the current node.
     //! \remark Stored is a body as one face with plane for reference plane, wire segment for reference axis, wire point for reference point
     //! \param [in] inRefgeom : reference geometry to Write.
     //! \param [in] inIdrefgeom : You may give an ID for reference geometry, to connect on. -1 for automatic ID.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddReferenceGeometry(const Dtk_BodyPtr& inRefgeom, Dtk_Int64 inIdrefgeom = -1);
 
// connectors
 
     //! \brief Connect a PMI on a ModelView
     //! \param [in] inIdpmi : PMI to connect. (ID given with AddPMI)
     //! \param [in] inIdModelView : ModelView to Connect. (ID given with AddModelView)
     //! \param [in] inRoute : if PMI is not in the same assembly node, indicate the route to reach it.
     //! \remark : route should contain at least the final target node, the ID given as inIdpart in OpenInstance. 
     //! \remark : for a full route, start with current assembly node ID, it can also contain some inInstanceID, but it should finish with a inIdpart
     //! \remark : if route is empty, API try to find automaticly.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus ConnectPMI_ModelView(Dtk_Int64 inIdpmi, Dtk_Int64 inIdModelView, const Dtk_tab<Dtk_Int64>& inRoute = Dtk_tab<Dtk_Int64>());
     //! \brief Connect a PMI on a body face/edge/vertex
     //! \param [in] inIdfdt : PMI to connect on  (ID given with AddPMI)
     //! \param [in] inGeomid : Geometry to link : DtkFacePtr::info()->GetId() / DtkEdgePtr::info()->GetId() / DtkVertexPtr::info()->GetId()
     //! \param [in] inTypegeom : Type of connection : DTK_TYPE_FACE or DTK_TYPE_EDGE or DTK_TYPE_VERTEX
     //! \param [in] inRoute : Route to body (see remarks of ConnectPMI_ModelView)
     //! \param [in] inBodyID : For a case of multiple bodies added into same node, give the inBody->info()->GetId() filled with function AddBody
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus ConnectPMI_Geom(Dtk_Int64 inIdfdt, Dtk_Int64 inGeomid, type_detk inTypegeom, const Dtk_tab<Dtk_Int64>& inRoute = Dtk_tab<Dtk_Int64>(), Dtk_ID inBodyID = 0);
     //! \brief Connect a PMI on another PMI
     //! \param [in] inIdpmifrom : PMI to link from (ID given with AddPMI)
     //! \param [in] inIdpmito : PMI to link to (ID given with AddPMI)
     //! \param [in] inRoute : Route to inIDfdt2 (see remarks of ConnectPMI_ModelView)
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus ConnectPMI_PMI(Dtk_Int64 inIdpmifrom, Dtk_Int64 inIdpmito, const Dtk_tab<Dtk_Int64>& inRoute = Dtk_tab<Dtk_Int64>());
     //! \brief Connect a ModelView on an Instance, for part representation restriction in a modelview
     //! \param [in] inIdModelView : ModelView to Connect (ID given by AddModelView)
     //! \param [in] inRoute : Route to instance (see remarks of ConnectPMI_ModelView) but this time, final ID should be inInstanceID given with LastInstance_SetInstanceID
     //! \param [in] inHide : If instance is hidden (default add instance as visible)
     //! \param [in] inBodyID : Restrict a target for a body into an instance.
     //! \param [in] inExplode : For exploded view, set the instance on a new place for this view.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus ConnectModelView_Instance(Dtk_Int64 inIdmodelview, const Dtk_tab<Dtk_Int64>& inRoute, int inHide = 0, Dtk_ID inBodyID = 0, const Dtk_transfo* const inExplode_absolute = NULL);
     //! \brief Set an override color for a specific instance
     //! \param [in] inRgb : Color to apply to instance.
     //! \param [in] inRoute : Route to instance (see remarks of ConnectPMI_ModelView) but this time, final ID should be inInstanceID given with LastInstance_SetInstanceID
     //! \param [in] inBodyID : Restrict a target for a body into an instance.
     //! \remark functionnality supported only from version 10.0
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddOverrideColor(const Dtk_RGB& inRgb, const Dtk_tab<Dtk_Int64>& inRoute, Dtk_ID inBodyID = 0);
     //! \brief Set a Lightmap for a specific instance
     //! \param [in] inLightmap : Color to apply to instance.
     //! \param [in] inRoute : Route to instance (see remarks of ConnectPMI_ModelView) but this time, final ID should be inInstanceID given with LastInstance_SetInstanceID
     //! \param [in] inBodyID : Restrict a target for a body into an instance.
     //! \remark functionnality supported only from version 10.0
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus AddOverrideColor(const Dtk_LightMapPtr& inLightmap, const Dtk_tab<Dtk_Int64>& inRoute, Dtk_ID inBodyID = 0);
};
 
 
 
 
 
 
 
 
// deprecated
 
#define JTW_BREP_NONE         0
#define JTW_BREP_XT           1
#define JTW_COLOR_DEFAULT     0
#define JTW_COLOR_OVERWRITE   1
#define JTW_VERSION_8_0       80
#define JTW_VERSION_9_5       95
#define JTW_UNIT_MILLIMETERS  0
#define JTW_UNIT_CENTIMETERS  1
#define JTW_UNIT_METERS            2
#define JTW_UNIT_INCHES            3
#define JTW_UNIT_FEET              4
#define JTW_UNIT_YARDS             5
#define JTW_UNIT_MICROMETERS  6
#define JTW_UNIT_DECIMETERS        7
#define JTW_UNIT_KILOMETERS        8
#define JTW_UNIT_MILS              9
#define JTW_UNIT_MILES             10
Dtk_ErrorStatus jtw_InitWrite(Dtk_string inFileWritten, Dtk_string inLogFile, Licence_dtk inLicFct = NULL,
     int inExptype = 0, int inBreptype = JTW_BREP_XT,
     int inVersion = JTW_VERSION_9_5, int inUnit = JTW_UNIT_MILLIMETERS);
Dtk_ErrorStatus jtw_InitChild(const Dtk_string& inName, Dtk_Int64 inIdpart, Dtk_bool& outWasAlreadyInstancied,
     const Dtk_transfo& inTrans = Dtk_transfo(), const Dtk_RGB& inRgb = Dtk_RGB(),
     const Dtk_string& inNewsubfile = Dtk_string(),
     int inColorstrategy = JTW_COLOR_DEFAULT, int inVisibility = 1, Dtk_Int64 inInstanceID = -1);
Dtk_ErrorStatus jtw_CloseChild();
Dtk_ErrorStatus jtw_AddMesh(const Dtk_MeshPtr& inMesh, Dtk_Float32 inLossytol = 0);
Dtk_ErrorStatus jtw_AddBody(const Dtk_BodyPtr& inBody, Dtk_Float32 inLossytol = 0);
Dtk_ErrorStatus jtw_AddBodyMultiLOD(const Dtk_BodyPtr& inBody, const Dtk_tab<Dtk_Float32>& inLodDatas, Dtk_Float32 inLossytol = 0);
Dtk_ErrorStatus jtw_AddFdt(const Dtk_FdtPtr& inFdt, Dtk_Int64 inIdfdt = -1);
Dtk_ErrorStatus jtw_AddModelView(const Dtk_ModelDisplayPtr& inMdl, Dtk_Int64 inIdModelView = -1);
Dtk_ErrorStatus jtw_AddMetaData(const Dtk_MetaDataPtr& inToWrite);
Dtk_ErrorStatus jtw_AddLayerInfosSet(const Dtk_LayerInfosSetPtr& inToWrite);
Dtk_ErrorStatus jtw_AddAxisSystem(const Dtk_AxisSystemPtr& inToWrite, Dtk_Int64 idaxis = -1);
Dtk_ErrorStatus jtw_AddReferenceGeometry(const Dtk_BodyPtr& inToWrite, Dtk_Int64 idref = -1);
Dtk_ErrorStatus jtw_ConnectFdt_ModelView(Dtk_Int64 inIdfdt, Dtk_Int64 inIdModelView, const Dtk_tab<Dtk_Int64>& inRoute = Dtk_tab<Dtk_Int64>());
Dtk_ErrorStatus jtw_ConnectFdt_Fdt(Dtk_Int64 inIdfdt, Dtk_Int64 inIdfdt2, const Dtk_tab<Dtk_Int64>& inRoute = Dtk_tab<Dtk_Int64>());
Dtk_ErrorStatus jtw_ConnectFdt_Geom(Dtk_Int64 inIdfdt, Dtk_Int64 inGeomid, type_detk inTypegeom, const Dtk_tab<Dtk_Int64>& inRoute = Dtk_tab<Dtk_Int64>(), Dtk_ID inBodyID = 0);
Dtk_ErrorStatus jtw_ConnectModelView_Instance(Dtk_Int64 inIdModelView,
     const Dtk_tab<Dtk_Int64>& inRoute = Dtk_tab<Dtk_Int64>(), int inHide = 0, Dtk_ID inBodyID = 0,
     const Dtk_transfo& inExplode = Dtk_transfo());
Dtk_ErrorStatus jtw_EndWrite();
 
#endif