satw.hpp

Go to the documentation of this file.

#include "def/define.h"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/error_dtk.hpp"
#include "util/util_stl_dtk.hpp"
#include "util/util_topology_ptr_dtk.hpp"
 
//! \defgroup sat_write Sat Write Functions
//! \brief .
 
//! \class satw_WriteOptions 
//! \brief This class provides several options to tune Sat Writer.\n
//! It must be provided to satw_InitFile method.
class satw_WriteOptions
{
public:
     //! DTK_TRUE: Writes pcurve entities, DTK_FALSE: no pcurve
     Dtk_bool WritePcurve;
     //! DTK_TRUE: Splits periodic faces, DTK_FALSE: no split
     Dtk_bool SplitPeriodicFaces;
     //! DTK_TRUE: To be used for dxf write only, DTK_FALSE: otherwise
     Dtk_bool WriteForDxfOutput;
     //! INTEGER: sat output version (5-7, 5 by default)
     Dtk_Size_t OutputVersion;
 
     //! \BaseConstructor
     satw_WriteOptions() : WritePcurve( DTK_FALSE ), SplitPeriodicFaces( DTK_TRUE ), WriteForDxfOutput( DTK_FALSE ), OutputVersion( 5 )
     {
     }
 
     //! \BaseDestructor
     ~satw_WriteOptions()
     {
     }
};
 
//! \ingroup sat_write
//! \brief Initializes a file to be written
//! \param [in] inFileOut : Sat File to write
//! \param [in] inOptions : options for Sat writer
//! \return 0 if OK , -4 if licence checking has failed
DtkErrorStatus satw_InitFile( const Dtk_string& inFileOut, const satw_WriteOptions& inOptions = satw_WriteOptions() );
 
//! \ingroup sat_write
//! \brief Initializes the writing of a 3D part
//! \return dtkNoError if done
//! Each product must have a 3D part, even empty : started by satw_InitPart, ended by satw_EndPart.
//! Between them there can be 0, 1 or more Bodies to write (by satw_WriteBody)
DtkErrorStatus satw_InitPart();
 
//! \ingroup sat_write
//! \brief Writes a Body
//! \param [in] inBody : the Body to be written
//! \return dtkNoError if done, dtkErrorUnspecified if inBody is null
DtkErrorStatus satw_WriteBody( const Dtk_BodyPtr& inBody );
 
//! \ingroup sat_write
//! \brief Writes a liste of Bodies with sewing or not
//! \param [in] inBodies : the Bodies to be written
//! \param [in] inSewing : DTK_TRUE if a sewing action of the bodies is performed, DTK_FALSE otherwise
//! \return dtkNoError if done, dtkErrorUnspecified if inBodies is empty
DtkErrorStatus satw_WriteBody( Dtk_tab<Dtk_BodyPtr> inBodies, Dtk_bool inSewing = DTK_TRUE );
 
//! \ingroup sat_write
//! \brief Ends the writing of a part
//! \return dtkNoError if OK
DtkErrorStatus satw_EndPart();
 
//! \ingroup sat_write
//! \brief Ends the writing of the Sat file
//! \return dtkNoError if OK
DtkErrorStatus satw_EndFile();