utilwriter.h

Go to the documentation of this file.

//Utility Fill Data for Writing Lib
#ifndef _UTILWRITER_H_
#define _UTILWRITER_H_
 
#include "util/BaseTypes/dtk_string.hpp"
#include "util/BaseTypes/dtk_rgb.hpp"
#include "util/util_stl_dtk.hpp"
#include "util/BaseTypes/dtk_pnt.hpp"
#include "util/util_ptr_dtk.hpp"
 
/****************************************************************************/
//! \brief Create a Face entity and returns its Id
//! \param [in] inFaceName : Name for face
//! \param [in] inLayer : Layer for Face
//! \param [in] inColour : Colour For Face
//! \param [in] inNumSegmentIntoUVBoudaries : Number of segment for each boundaries (outer first)
//! \return  int Id of face
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
int dtk_InitFaceToWrite(Dtk_string inFaceName,int inLayer,Dtk_RGB inColour, Dtk_tab<int> &inNumSegmentIntoUVBoudaries);
 
/****************************************************************************/
//! \brief Construct basis surface(Nurbs Surface) for face 
//! \param [in] inFaceNumber : Face number given by dtk_InitFaceToWrite
//! \param [in] inUDegree : 
//! \param [in] inVDegree : 
//! \param [in] inUKnots : 
//! \param [in] inVKnots : 
//! \param [in] inWeights : 
//! \param [in] inControlPoints : 
//! \return  int 
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
int dtk_AddBasisSurface(int inFaceNumber,int inUDegree,int inVDegree,Dtk_tab<double> &inUKnots,Dtk_tab<double> &inVKnots,Dtk_tab<double> &inWeights,Dtk_tab<Dtk_pnt> &inControlPoints);
 
/****************************************************************************/
//! \brief Add a segment for Boundaries
//! \param [in] inFaceNumber : Face number given by dtk_InitFaceToWrite
//! \param [in] inNumBoundary : 
//! \param [in] inNumSegment : 
//! \param [in] inDegree : 
//! \param [in] inKnots : 
//! \param [in] inWeights : 
//! \param [in] inControlPoints : 
//! \return  int 
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
int dtk_AddSegmentInBoundary(int inFaceNumber,int inNumBoundary,int inNumSegment,int inDegree,Dtk_tab<double> &inKnots,Dtk_tab<double> &inWeights,Dtk_tab<Dtk_pnt> &inControlPoints);
 
/****************************************************************************/
//! \brief Free memory allocated by dtk_InitFaceToWrite
//! \param [in] inFaceNumber : Face number given by dtk_InitFaceToWrite
//! \return  void 
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
void dtk_FreeFaceToWrite(int inFaceNumber);
 
/****************************************************************************/
//! \brief Return the pointer to write
//! \param [in] inFaceNumber : Face number given by dtk_InitFaceToWrite
//! \return  Dtk_EntityPtr
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
Dtk_EntityPtr dtk_GetFaceToWrite(int inFaceNumber);
 
/****************************************************************************/
//! \brief Create a NURBS Curve entity and return its Id
//! \param [in] inCurveName : Name
//! \param [in] inLayer : Layer
//! \param [in] inColour : Colour
//! \param [in] inDegree : degree
//! \param [in] inKnots : knots vector
//! \param [in] inWeights : weight if rationnal or empty Dtk_tab
//! \param [in] inControlPoints : Control points for nurbs
//! \return  int Curve Id or -1 if failed
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
int dtk_InitCurveToWrite(Dtk_string inCurveName,int inLayer,Dtk_RGB inColour,int inDegree,Dtk_tab<double> &inKnots,Dtk_tab<double> &inWeights,Dtk_tab<Dtk_pnt> &inControlPoints);
/****************************************************************************/
//! \brief Create a Line entity and return its Id
//! \param [in] inCurveName : Name
//! \param [in] inLayer : Layer
//! \param [in] inColour : Colour
//! \param [in] inFirstPoint : FirstPoint of line
//! \param [in] inLastPoint : LastPoint of line
//! \return  int Curve Id or -1 if failed
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
int dtk_InitCurveToWrite(Dtk_string inCurveName,int inLayer,Dtk_RGB inColour,const Dtk_pnt &inFirstPoint,const Dtk_pnt &inLastPoint);
/****************************************************************************/
//! \brief Create a Ellipse or Circle entity and return its Id
//! \param [in] inCurveName : Name
//! \param [in] inLayer : Layer
//! \param [in] inColour : Colour
//! \param [in] inCenterPoint : CenterPoint
//! \param [in] inNormal : Normal vector
//! \param [in] inReference : Direction for parameter U=0
//! \param [in] inMajorRadius : Major radius for ellipse
//! \param [in] inMinorRadius : Minor radius for ellipse  if Major = Minor ---> Circle
//! \param [in] inUTrimMin : first trim parameter  0<inUTrimMin<inUTrimMax<2*Pi  .If out of range --> full ellipse
//! \param [in] inUTrimMax : last trim parameter   0<inUTrimMin<inUTrimMax<2*Pi
//! \return  int Curve Id or -1 if failed
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
int dtk_InitCurveToWrite(Dtk_string inCurveName,
                         int inLayer,
                         Dtk_RGB inColour,
                         const Dtk_pnt &inCenterPoint,
                         const Dtk_dir &inNormal,
                         const Dtk_dir &inReference,
                         const Dtk_Double64& inMajorRadius,
                         const Dtk_Double64& inMinorRadius,
                         const Dtk_Double64 inUTrimMin,
                         const Dtk_Double64 inUTrimMax);
 
/****************************************************************************/
//! \brief Free memory allocated by dtk_InitCurveToWrite
//! \param [in] inCurveNumber :  Curve number given by dtk_InitCurveToWrite
//! \return  void 
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
void dtk_FreeCurveToWrite(int inCurveNumber);
 
/****************************************************************************/
//! \brief  Return the pointer to write
//! \param [in] inCurveNumber : Curve number given by dtk_InitCurveToWrite
//! \return  Dtk_EntityPtr
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
Dtk_EntityPtr dtk_GetCurveToWrite(int inCurveNumber);
 
/****************************************************************************/
//! \brief  Create a point entity and return its Id
//! \param [in] inPointName : Name for point
//! \param [in] inLayer : Layer for point
//! \param [in] inColour : Colour for point
//! \param [in] inPoint : coordinates
//! \return  int 
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
int dtk_InitPointToWrite(Dtk_string inPointName,int inLayer,Dtk_RGB inColour,Dtk_pnt inPoint);
 
/****************************************************************************/
//! \brief  Free memory allocated by dtk_InitPointToWrite
//! \param [in] inPointNumber : Point number given by dtk_InitPointToWrite
//! \return  void 
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
void dtk_FreePointToWrite(int inPointNumber);
 
/****************************************************************************/
//! \brief  Return the pointer to write
//! \param [in] inPointNumber : Point number given by dtk_InitPointToWrite
//! \return  Dtk_EntityPtr
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
Dtk_EntityPtr dtk_GetPointToWrite(int inPointNumber);
 
 
/****************************************************************************/
//! \brief  Dump a Face into binary file to send us if writing fails
//! \param [in] inFileName : Name for Dump File
//! \param [in] inFaceNumber : id for Face to dump
//! \return  void
//! \b Sample:
//! \code
//! 
//! 
//! 
//! \endcode
void dtk_DumpFaceToWrite(Dtk_string inFileName,int inFaceNumber);
 
 
#endif