pdfw.hpp

Go to the documentation of this file.

#ifndef _PDF_WRITER_HPP
#define _PDF_WRITER_HPP
 
#include "util/util_ent_dtk.hpp"
#include "util/util_mesh_dtk.hpp"
#include "util/util_draw_dtk.hpp"
 
namespace Pdfw
{
     // Graphic Attributes inheritance
     enum graphicinheritance
     {
          attributeoverwrite = 0x00,  // node color and transparency will overload all objects( default ),
          keepsubcolor = 0x01,          // node color will overload only uncolored objects,
          keepsubtransparency = 0x02  // node transparency will affect only objects with no transparency defined
     };
     struct cross_section
     {
          Dtk_bool ShowIntersection;
          Dtk_bool AddSectionCap;
          Dtk_bool ShowCuttingPlane;
          Dtk_RGB IntersectionColor;
          Dtk_RGB CuttingPlaneColor;
          Dtk_Double64 CuttingPlaneOpacity;
     };
 
     struct LayoutOptions
     {
          Dtk_bool CreateAutomaticLayout;
          Dtk_bool RasterizeTexts;
          Dtk_bool WriteLineThickness;
          Dtk_string TTF_Font;
          Dtk_string TTF_BoldFont;
          Dtk_string TTF_ItalicFont;
          Dtk_string TTF_BoldItalicFont;
          Dtk_bool _3DAnnotActivation;
          Dtk_Double64 _3DAnnotSize[ 4 ];
          Dtk_bool ProcessDrawingBBoxAsPageBBox;
          Dtk_Double64 DrawingMarginsSize;
 
     };
 
     typedef enum RenderMode
     {
          Solid = 0,
          SolidWireframe = 1,
          Transparent = 2,
          TransparentWireframe = 3,
          BoundingBox = 4,
          TransparentBoundingBox = 5,
          TransparentBoundingBoxOutline = 6,
          Wireframe = 7,
          ShadedWireframe = 8,
          HiddenWireframe = 9,
          Vertices = 10,
          ShadedVertices = 11,
          Illustration = 12,
          SolidOutline = 13,
          ShadedIllustration = 14,
          Unset = 255
     } RenderMode;
 
     typedef enum Lighting
     {
          NoLights = 0,
          LightsFromFile,
          WhiteLights,
          DayLights,
          BrightLights,
          PrimaryColorLights,
          NightLights,
          BlueLights,
          RedLights,
          CubeLights,
          CADOptimizedLights,
          HeadLamp,
          UnsetLighting = 255
     } Lighting;
 
     class WriteOptions
     {
     protected:
 
     public:
 
          WriteOptions()
          {
               CreateDefaultView = 1; DefaultViewBGColor = Dtk_RGB( 128, 128, 128 ); SeparateActiveViews = 0;  WriteModelDisplay = 1; WriteMeshCurves = 0; ConvertRenderInfos = 1;
               CrossSection.ShowIntersection = 1; CrossSection.AddSectionCap = 1; CrossSection.ShowCuttingPlane = 0;
               CrossSection.IntersectionColor = Dtk_RGB( 255, 0, 0 ); CrossSection.CuttingPlaneColor = Dtk_RGB( 255, 255, 255 );
               CrossSection.CuttingPlaneOpacity = 1.0; WritePRC = DTK_TRUE; PointSize = 3.0; ShowToolbar = DTK_TRUE; ShowTree = DTK_TRUE; TransparentBackground = DTK_FALSE;
               DefaultRenderMode = Solid; DefaultLighting = CADOptimizedLights; UserPassword = Dtk_string(); OwnerPassword = Dtk_string(); JSFilePath = Dtk_string(); JSFileWriteMode = "a";
               PrcTessAngle = 40.0; PrcTessChordHeight = 2000.0; PrcActivateCompTess = DTK_FALSE; PrcCompTessTol = 0.001; Layout.CreateAutomaticLayout = DTK_TRUE; Layout.RasterizeTexts = DTK_TRUE; Layout.WriteLineThickness = DTK_FALSE;
               Layout.TTF_BoldFont = Dtk_string(); Layout.TTF_BoldItalicFont = Dtk_string(); Layout.TTF_Font = Dtk_string();
               Layout.TTF_ItalicFont = Dtk_string(); Layout._3DAnnotActivation = 0, Layout._3DAnnotSize[ 0 ] = 1E50, Layout._3DAnnotSize[ 1 ] = 1E50, Layout._3DAnnotSize[ 2 ] = -1E50,
                    Layout._3DAnnotSize[ 3 ] = -1E50; RasterizeSymbols = DTK_FALSE; SplitLeaders = DTK_FALSE;
          }
          WriteOptions& operator = ( const WriteOptions& s );
          ~WriteOptions()
          {
          }
 
          Dtk_bool CreateDefaultView;
          Dtk_RGB DefaultViewBGColor;
          Dtk_bool SeparateActiveViews;
          Dtk_bool ShowToolbar;
          Dtk_bool ShowTree;
          RenderMode DefaultRenderMode;
          Lighting DefaultLighting;
          Dtk_bool TransparentBackground;
          Dtk_bool WriteModelDisplay;
          Dtk_bool WriteMeshCurves;
          Dtk_bool ConvertRenderInfos;
          Dtk_bool WritePRC;
          Dtk_Double64 PointSize;
          cross_section CrossSection;
          Dtk_string UserPassword;
          Dtk_string OwnerPassword;
          Dtk_string JSFilePath;
          Dtk_string JSFileWriteMode;
          Dtk_Double64 PrcTessAngle; // the minimal angle, in degrees, for triangles in the tessellation.
          Dtk_Double64 PrcTessChordHeight; // the minimal chord height, in millimeters, for deviation between triangles and the exact surface in the tessellation.
 
          Dtk_bool PrcActivateCompTess;
          Dtk_Double64 PrcCompTessTol;
 
          Dtk_bool RasterizeSymbols;
          Dtk_bool SplitLeaders;
 
          //Layout options
          LayoutOptions Layout;
     };
 
     class PdfDocumentProperties
     {
     private:
          Dtk_string Title;
          Dtk_string Author;
          Dtk_string Subject;
          Dtk_string Keywords;
          Dtk_string Application;
          Dtk_string PDFProducer;
     public:
          PdfDocumentProperties();
          ~PdfDocumentProperties();
          void SetTitle( const Dtk_string & inString );
          void SetAuthor( const Dtk_string & inString );
          void SetSubject( const Dtk_string & inString );
          void SetKeywords( const Dtk_string & inString );
          void SetApplication( const Dtk_string & inString );
          void SetPDFProducer( const Dtk_string & inString );
 
          const Dtk_string &GetTitle() const;
          const Dtk_string &GetAuthor() const;
          const Dtk_string &GetSubject() const;
          const Dtk_string &GetKeywords() const;
          const Dtk_string &GetApplication() const;
          const Dtk_string &GetPDFProducer() const;
          
     };
 
     DtkErrorStatus InitWrite( const Dtk_string& inOutputFile, const Dtk_string& inLogFile, Licence_dtk inLicFct, WriteOptions& inOptions );
 
     DtkErrorStatus EndWrite();
 
     Dtk_ErrorStatus AddDocumentProperties( const Pdfw::PdfDocumentProperties &inDocProperties,
                                                        const Dtk_tab<Dtk_MetaDataPtr> &inMetadatas);
 
     Dtk_bool IsWriteInitialized();
 
     Dtk_ErrorStatus WriteEntity( const Dtk_EntityPtr& inEntity );
 
     Dtk_ErrorStatus WriteEntity( const Dtk_EntityPtr& inEntity, Dtk_ID &outID );
 
     DtkErrorStatus WriteBodyAndMesh( const Dtk_BodyPtr& inBody, const Dtk_MeshPtr &inMesh, Dtk_ID &outID );
 
     Dtk_ErrorStatus WritePolylines( Dtk_tab < Dtk_PolylinePtr > &inTabPolylines, Dtk_ID &outID, Dtk_InfoPtr inInfo = Dtk_InfoPtr() );
 
     Dtk_ErrorStatus WritePoints( Dtk_tab < Dtk_PointPtr >&inTabPoints, Dtk_ID &outID, Dtk_InfoPtr inInfo = Dtk_InfoPtr() );
 
     Dtk_ErrorStatus WriteColoredPoints( Dtk_tab < Dtk_pnt >&inTabPoints,
                                                  Dtk_tab < Dtk_dir >&inTabNormals,
                                                  Dtk_tab < Dtk_RGB >&inTabColors,
                                                  Dtk_ID &outID,
                                                  Dtk_InfoPtr inInfo = Dtk_InfoPtr() );
 
     DtkErrorStatus InitNode( Dtk_string& inNodeName, const Dtk_transfo& inTransfo = Dtk_transfo() );
 
     DtkErrorStatus InitNode( Dtk_string& inNodeName, const Dtk_transfo& inTransfo, const Dtk_bool &inVisi, Dtk_ID &outID );
 
     DtkErrorStatus InitNode( Dtk_string& inNodeName, const Dtk_transfo& inTransfo, Dtk_InfoPtr &inInfo, Dtk_UChar8 inHeritStrategy, Dtk_ID &outID );
 
 
     DtkErrorStatus InitNode( Dtk_string& inNodeName, const Dtk_transfo& inTransfo, Dtk_InfoPtr &inInfo, Dtk_ID &outID );
 
     DtkErrorStatus EndNode();
 
     void StorePrototype( Dtk_ID inID );
 
     DtkErrorStatus ReinstanciatePrototype( Dtk_ID inID );
 
     DtkErrorStatus AddNodeMetadata( Dtk_tab<Dtk_MetaDataPtr> &inTabMetadata );
 
     DtkErrorStatus AddNodeRenderInfo( Dtk_RenderInfosPtr inRenderInfos );
 
     DtkErrorStatus CreateModelDisplayWithVisibleNodes( Dtk_ModelDisplayPtr &inModelDisplay,
                                                                    Dtk_tab<Dtk_ID>&inTabVisibleNodes,
                                                                    Pdfw::RenderMode inRenderMode = Pdfw::Unset,
                                                                    Pdfw::Lighting inLighting = Pdfw::UnsetLighting );
 
 
     Dtk_ErrorStatus CreateNodeConnectorHighlight( const Dtk_ID &inPointingNodeID,
                                                              const Dtk_ID &inPointedNodeID,
                                                              const Dtk_UInt32 &inFaceIndex = -1,
                                                              Dtk_Int32 inReasonLink = 0 );
 
     Dtk_ErrorStatus WriteParallelToScreenPicture( const Dtk_string &inPictureFilePath,
                                                              Dtk_Double64 inPictureWidth,
                                                              Dtk_Double64 inPictureHeight,
                                                              Dtk_anchor_type inAnchorType,
                                                              bool inIsZoomable,
                                                              bool inIsOnTop,
                                                              Dtk_transfo inTransfo,
                                                              Dtk_LeaderPtr &inLeader );
 
     Dtk_ErrorStatus WritePinToScreenPicture( const Dtk_string &inPictureFilePath,
                                                        Dtk_Double64 inPictureWidth,
                                                        Dtk_Double64 inPictureHeight,
                                                        Dtk_pnt  inPictureOrigin,
                                                        Dtk_anchor_type inAnchorType,
                                                        bool inIsOnTop,
                                                        Dtk_LeaderPtr &inLeader );
 
     namespace Layout
     {
          typedef enum _PageSizes
          {
               SIZE_LETTER = 0,
               SIZE_LEGAL,
               SIZE_A3,
               SIZE_A4,
               SIZE_A5,
               SIZE_B4,
               SIZE_B5,
               SIZE_EXECUTIVE,
               SIZE_US4x6,
               SIZE_US4x8,
               SIZE_US5x7,
               SIZE_COMM10,
               SIZE_EOF
          } PageSizes;
 
 
          typedef enum _PageDirection
          {
               PORTRAIT = 0,
               LANDSCAPE
          } PageDirection;
 
 
          Dtk_ErrorStatus InitPage( Dtk_RGB inColor = Dtk_RGB( 255, 255, 255 ), Dtk_Double64 inWidth = 842, Dtk_Double64 inHeight = 595 );
 
          Dtk_ErrorStatus EndPage();
 
          Dtk_ErrorStatus CreateOutline( Dtk_string inName );
 
          DtkErrorStatus Init3DArtwork( Dtk_string inAnnotName = Dtk_string(), Pdfw::WriteOptions *inWriteOptions = NULL );
 
          DtkErrorStatus End3DArtwork( Dtk_UInt32 &outartworkIndex );
 
          DtkErrorStatus Get3DArtworkBBox( Dtk_pnt &outPmin, Dtk_pnt &outPmax );
 
          DtkErrorStatus Create3DAnnotation( Dtk_UInt32 inArtworkIndex,
                                                     Dtk_Double64 inBBox[ 4 ],
                                                     Dtk_Int32 inModelDisplayIndex = -1,
                                                     Dtk_Int32 inLayerID = -1,
                                                     RenderMode inRenderMode = Unset,
                                                     Lighting   inLighting = UnsetLighting,
                                                     Dtk_bool   inAnnotActivation = 0 );
 
          Dtk_ErrorStatus SetCurrentPageSize( PageSizes inSize, PageDirection inDirection );
 
          Dtk_ErrorStatus SetCurrentPageSize( Dtk_Double64 inWidth, Dtk_Double64 inHeight );
 
          Dtk_Double64 GetCurrentPageWidth();
 
          Dtk_Double64 GetCurrentPageHeight();
 
          Dtk_ErrorStatus WritePolylines( Dtk_tab<Dtk_PolylinePtr>&inTabPolylines );
 
          Dtk_ErrorStatus WriteCompositeText( Dtk_CompositeText &inCompositeText );
 
          Dtk_ErrorStatus WritePicture( Dtk_string inPicturePath, Dtk_Double64 inPictureBBox[ 4 ] );
 
          Dtk_ErrorStatus FillRectangle( Dtk_Double64 inBBox[ 4 ], Dtk_RGB inColor );
 
     }
 
     //DEPRECATED
     Dtk_ErrorStatus WritePictureWithLeaderLine( const Dtk_string &inPictureFilePath,
                                                            Dtk_Double64 inPictureWidth,
                                                            Dtk_Double64 inPictureHeight,
                                                            Dtk_anchor_type inAnchorType,
                                                            Dtk_Fdt::ScreenDisplayEnum inScreenDisplayAttrib,
                                                            bool inIsZoomable,
                                                            bool inIsOnTop,
                                                            Dtk_pnt   inPictureOrigin,
                                                            Dtk_transfo inTransfo,
                                                            Dtk_LeaderPtr &inLeader );
 
     SetAsDeprecated("Undefined", "Use CreateNodeConnectorHighlight()")
     Dtk_ErrorStatus CreateConnectorFdtFace( const Dtk_ID &inFdtID,
                                                       const Dtk_tab <Dtk_ID> &inNodePathIDs,
                                                       const Dtk_Size_t &inFaceIndex );
 
     SetAsDeprecated("Undefined", "CreateModelDisplayWithVisibleNodes()")
     DtkErrorStatus CreateModelDisplay( Dtk_string& inName,
                                                Dtk_CameraPtr inCamera,
                                                Dtk_EntityPtr inClippingEntity,
                                                Dtk_tab<Dtk_ID>&inTabVisibleNodes,
                                                Dtk_tab<Dtk_transfo>inTabTransfo = Dtk_tab<Dtk_transfo>(),
                                                Dtk_RGB inBackgroundColor = Dtk_RGB() );
 
     SetAsDeprecated("Undefined", "CreateModelDisplayWithVisibleNodes()")
     DtkErrorStatus CreateModelDisplay( Dtk_string& inName,
                                                Dtk_CameraPtr inCamera,
                                                Dtk_EntityPtr inClippingEntity,
                                                Dtk_tab<Dtk_ID>&inTabVisibleNodes,
                                                Dtk_tab<Dtk_transfo>&inTabTransfo,
                                                Dtk_RGB inBackgroundColor,
                                                Dtk_bool inManageHideShowBody );
 
 
     // ! \deprecated => Use other WriteColoredPoints()
     SetAsDeprecated("Undefined", "")
     Dtk_ErrorStatus WriteColoredPoints( Dtk_tab < Dtk_PointPtr >&inTabPoints,
                                                  Dtk_tab < Dtk_dir >&inTabNormals,
                                                  Dtk_ID &outID,
                                                  Dtk_InfoPtr inInfo = Dtk_InfoPtr() );
 
 
}
 
 
#endif