DATAKIT API  V2025.1
Pdfw::WriteOptions Class Reference

This class provides several options to tune Pdf Writer.
It must be provided to Pdfw::InitWrite method. More...

Public Member Functions

WriteOptionsoperator= (const WriteOptions &s)
 \Operator = More...
 
 WriteOptions ()
 Base constructor. More...
 
 ~WriteOptions ()
 Destructor. More...
 

Data Fields

Dtk_bool ConvertRenderInfos
 DTK_TRUE : Creates render infos (lightning + texturing), DTK_FALSE : no render infos. More...
 
Dtk_bool CreateDefaultView
 DTK_TRUE : Creates Default View (isometric view), DTK_FALSE : no default view. More...
 
cross_section CrossSection
 Cross section parameters. More...
 
Lighting DefaultLighting
 Model Lighting mode in Acrobat. More...
 
RenderMode DefaultRenderMode
 Model render mode in Acrobat. More...
 
Dtk_RGB DefaultViewBGColor
 Dtk_RGB(128,128,128) : Sets color of background default view. This color has RGB attributer, not A, it does not handle transparency. More...
 
Dtk_string JSFilePath
 Adds a JavaScript file path executed for current 3D Artwork. More...
 
Dtk_string JSFileWriteMode
 
LayoutOptions Layout
 
Dtk_string OwnerPassword
 
Dtk_Double64 PointSize
 Size of points. More...
 
Dtk_bool PrcActivateCompTess
 
Dtk_Double64 PrcCompTessTol
 (Future Use) 3D point tolerance More...
 
Dtk_Double64 PrcTessAngle
 
Dtk_Double64 PrcTessChordHeight
 
Dtk_bool RasterizeSymbols
 DTK_TRUE : Rasterizes symbols to avoid PRC font problem, DTK_FALSE : Using texts. More...
 
Dtk_bool SeparateActiveViews
 DTK_TRUE : Creates one 3d pdf annotation for each active view, DTK_FALSE : only one 3d annotation. More...
 
Dtk_bool ShowToolbar
 DTK_TRUE : Show 3D Toolbar, DTK_FALSE : Hides 3D Toolbar. More...
 
Dtk_bool ShowTree
 DTK_TRUE : Show Model Tree, DTK_FALSE : Hides Model Tree. More...
 
Dtk_bool SplitLeaders
 DTK_TRUE : Splits leaders to text frames. More...
 
Dtk_bool TransparentBackground
 DTK_TRUE : Transparent Background, DTK_FALSE : Opaque Background. More...
 
Dtk_string UserPassword
 
Dtk_bool WriteMeshCurves
 DTK_TRUE : Creates mesh curves (face boundaries), DTK_FALSE : no mesh curves (obsolete field) More...
 
Dtk_bool WriteModelDisplay
 DTK_TRUE : Creates model displays, DTK_FALSE : no model displays. More...
 
Dtk_bool WritePRC
 DTK_TRUE : Embedding PRC file, DTK_FALSE : Embedding U3D file. More...
 

Detailed Description

This class provides several options to tune Pdf Writer.
It must be provided to Pdfw::InitWrite method.

//...
Dtk_string LogFile = L"MyLogFile.log";
Pdfw::WriteOptions PdfOptions;
Dtk_ErrorStatus err = Pdfw::InitWrite( LogFile, NULL, PdfOptions);
//...

Constructor & Destructor Documentation

◆ WriteOptions()

Pdfw::WriteOptions::WriteOptions ( )

Base constructor.

120  {
123  CrossSection.IntersectionColor = Dtk_RGB( 255, 0, 0 ); CrossSection.CuttingPlaneColor = Dtk_RGB( 255, 255, 255 );
126  PrcTessAngle = 40.0; PrcTessChordHeight = 2000.0; PrcActivateCompTess = DTK_FALSE; PrcCompTessTol = 0.001; Layout.CreateAutomaticLayout = DTK_TRUE; Layout.RasterizeTexts = DTK_TRUE; Layout.WriteLineThickness = DTK_FALSE;
127  Layout.TTF_BoldFont = Dtk_string(); Layout.TTF_BoldItalicFont = Dtk_string(); Layout.TTF_Font = Dtk_string();
128  Layout.TTF_ItalicFont = Dtk_string(); Layout._3DAnnotActivation = 0, Layout._3DAnnotSize[ 0 ] = 1E50, Layout._3DAnnotSize[ 1 ] = 1E50, Layout._3DAnnotSize[ 2 ] = -1E50,
129  Layout._3DAnnotSize[ 3 ] = -1E50; RasterizeSymbols = DTK_FALSE; SplitLeaders = DTK_FALSE;
130  }

◆ ~WriteOptions()

Pdfw::WriteOptions::~WriteOptions ( )

Destructor.

135  {
136  }

Member Function Documentation

◆ operator=()

WriteOptions& Pdfw::WriteOptions::operator= ( const WriteOptions s)

\Operator =

Field Documentation

◆ ConvertRenderInfos

Dtk_bool Pdfw::WriteOptions::ConvertRenderInfos

DTK_TRUE : Creates render infos (lightning + texturing), DTK_FALSE : no render infos.

◆ CreateDefaultView

Dtk_bool Pdfw::WriteOptions::CreateDefaultView

DTK_TRUE : Creates Default View (isometric view), DTK_FALSE : no default view.

◆ CrossSection

cross_section Pdfw::WriteOptions::CrossSection

Cross section parameters.

◆ DefaultLighting

Lighting Pdfw::WriteOptions::DefaultLighting

Model Lighting mode in Acrobat.

◆ DefaultRenderMode

RenderMode Pdfw::WriteOptions::DefaultRenderMode

Model render mode in Acrobat.

◆ DefaultViewBGColor

Dtk_RGB Pdfw::WriteOptions::DefaultViewBGColor

Dtk_RGB(128,128,128) : Sets color of background default view. This color has RGB attributer, not A, it does not handle transparency.

◆ JSFilePath

Dtk_string Pdfw::WriteOptions::JSFilePath

Adds a JavaScript file path executed for current 3D Artwork.

◆ JSFileWriteMode

Dtk_string Pdfw::WriteOptions::JSFileWriteMode

◆ Layout

LayoutOptions Pdfw::WriteOptions::Layout

◆ OwnerPassword

Dtk_string Pdfw::WriteOptions::OwnerPassword

Creates the password for the user of the document. The user_password may be set to NULL or zero length string.

◆ PointSize

Dtk_Double64 Pdfw::WriteOptions::PointSize

Size of points.

◆ PrcActivateCompTess

Dtk_bool Pdfw::WriteOptions::PrcActivateCompTess

Compressed Tessellation section parameters (Future Use) (Future Use) DTK_FALSE : no compressed tessellation, DTK_TRUE : activates compressed tessellation

◆ PrcCompTessTol

Dtk_Double64 Pdfw::WriteOptions::PrcCompTessTol

(Future Use) 3D point tolerance

◆ PrcTessAngle

Dtk_Double64 Pdfw::WriteOptions::PrcTessAngle

PRC extensions for precision controlled tessellation These attributes supersede the nominal parameters for tessellation

◆ PrcTessChordHeight

Dtk_Double64 Pdfw::WriteOptions::PrcTessChordHeight

◆ RasterizeSymbols

Dtk_bool Pdfw::WriteOptions::RasterizeSymbols

DTK_TRUE : Rasterizes symbols to avoid PRC font problem, DTK_FALSE : Using texts.

◆ SeparateActiveViews

Dtk_bool Pdfw::WriteOptions::SeparateActiveViews

DTK_TRUE : Creates one 3d pdf annotation for each active view, DTK_FALSE : only one 3d annotation.

◆ ShowToolbar

Dtk_bool Pdfw::WriteOptions::ShowToolbar

DTK_TRUE : Show 3D Toolbar, DTK_FALSE : Hides 3D Toolbar.

◆ ShowTree

Dtk_bool Pdfw::WriteOptions::ShowTree

DTK_TRUE : Show Model Tree, DTK_FALSE : Hides Model Tree.

◆ SplitLeaders

Dtk_bool Pdfw::WriteOptions::SplitLeaders

DTK_TRUE : Splits leaders to text frames.

◆ TransparentBackground

Dtk_bool Pdfw::WriteOptions::TransparentBackground

DTK_TRUE : Transparent Background, DTK_FALSE : Opaque Background.

◆ UserPassword

Dtk_string Pdfw::WriteOptions::UserPassword

Creates the password for the owner of the document. The owner can change the permission of the document. NULL, zero length string, and the same value as user password are not allowed.

◆ WriteMeshCurves

Dtk_bool Pdfw::WriteOptions::WriteMeshCurves

DTK_TRUE : Creates mesh curves (face boundaries), DTK_FALSE : no mesh curves (obsolete field)

◆ WriteModelDisplay

Dtk_bool Pdfw::WriteOptions::WriteModelDisplay

DTK_TRUE : Creates model displays, DTK_FALSE : no model displays.

◆ WritePRC

Dtk_bool Pdfw::WriteOptions::WritePRC

DTK_TRUE : Embedding PRC file, DTK_FALSE : Embedding U3D file.

Pdfw::WriteOptions
This class provides several options to tune Pdf Writer. It must be provided to Pdfw::InitWrite method...
Definition: pdfw.hpp:113
Pdfw::InitWrite
DtkErrorStatus InitWrite(const Dtk_string &inOutputFile, const Dtk_string &inLogFile, Licence_dtk inLicFct, WriteOptions &inOptions)
Initialize the PDF Writer
Pdfw::WriteOptions::PointSize
Dtk_Double64 PointSize
Size of points.
Definition: pdfw.hpp:163
Pdfw::Solid
@ Solid
Definition: pdfw.hpp:67
Pdfw::WriteOptions::PrcCompTessTol
Dtk_Double64 PrcCompTessTol
(Future Use) 3D point tolerance
Definition: pdfw.hpp:185
DTK_TRUE
#define DTK_TRUE
Definition: define.h:727
Pdfw::WriteOptions::JSFilePath
Dtk_string JSFilePath
Adds a JavaScript file path executed for current 3D Artwork.
Definition: pdfw.hpp:174
Pdfw::WriteOptions::WriteMeshCurves
Dtk_bool WriteMeshCurves
DTK_TRUE : Creates mesh curves (face boundaries), DTK_FALSE : no mesh curves (obsolete field)
Definition: pdfw.hpp:157
Dtk_string
This is a high level string class.
Definition: dtk_string.hpp:58
Pdfw::WriteOptions::PrcTessChordHeight
Dtk_Double64 PrcTessChordHeight
Definition: pdfw.hpp:179
Pdfw::WriteOptions::PrcActivateCompTess
Dtk_bool PrcActivateCompTess
Definition: pdfw.hpp:183
Pdfw::WriteOptions::CrossSection
cross_section CrossSection
Cross section parameters.
Definition: pdfw.hpp:165
Pdfw::cross_section::CuttingPlaneOpacity
Dtk_Double64 CuttingPlaneOpacity
Definition: pdfw.hpp:28
Pdfw::WriteOptions::DefaultViewBGColor
Dtk_RGB DefaultViewBGColor
Dtk_RGB(128,128,128) : Sets color of background default view. This color has RGB attributer,...
Definition: pdfw.hpp:141
DTK_FALSE
#define DTK_FALSE
Definition: define.h:728
Pdfw::cross_section::CuttingPlaneColor
Dtk_RGB CuttingPlaneColor
Definition: pdfw.hpp:27
Pdfw::cross_section::ShowCuttingPlane
Dtk_bool ShowCuttingPlane
Definition: pdfw.hpp:25
Layout
This namespace provides several methods for pdf layout management. .
Pdfw::WriteOptions::ShowTree
Dtk_bool ShowTree
DTK_TRUE : Show Model Tree, DTK_FALSE : Hides Model Tree.
Definition: pdfw.hpp:147
Pdfw::cross_section::ShowIntersection
Dtk_bool ShowIntersection
Definition: pdfw.hpp:23
Pdfw::WriteOptions::DefaultLighting
Lighting DefaultLighting
Model Lighting mode in Acrobat.
Definition: pdfw.hpp:151
Dtk_ErrorStatus
Dtk_ErrorStatus
Definition: error_dtk.hpp:6
Pdfw::WriteOptions::DefaultRenderMode
RenderMode DefaultRenderMode
Model render mode in Acrobat.
Definition: pdfw.hpp:149
Pdfw::WriteOptions::OwnerPassword
Dtk_string OwnerPassword
Definition: pdfw.hpp:172
Pdfw::WriteOptions::JSFileWriteMode
Dtk_string JSFileWriteMode
Definition: pdfw.hpp:175
Pdfw::cross_section::AddSectionCap
Dtk_bool AddSectionCap
Definition: pdfw.hpp:24
Pdfw::WriteOptions::PrcTessAngle
Dtk_Double64 PrcTessAngle
Definition: pdfw.hpp:178
Pdfw::WriteOptions::UserPassword
Dtk_string UserPassword
Definition: pdfw.hpp:169
Pdfw::WriteOptions::ConvertRenderInfos
Dtk_bool ConvertRenderInfos
DTK_TRUE : Creates render infos (lightning + texturing), DTK_FALSE : no render infos.
Definition: pdfw.hpp:159
Pdfw::WriteOptions::WritePRC
Dtk_bool WritePRC
DTK_TRUE : Embedding PRC file, DTK_FALSE : Embedding U3D file.
Definition: pdfw.hpp:161
Pdfw::WriteOptions::WriteModelDisplay
Dtk_bool WriteModelDisplay
DTK_TRUE : Creates model displays, DTK_FALSE : no model displays.
Definition: pdfw.hpp:155
Pdfw::CADOptimizedLights
@ CADOptimizedLights
Definition: pdfw.hpp:97
Pdfw::WriteOptions::RasterizeSymbols
Dtk_bool RasterizeSymbols
DTK_TRUE : Rasterizes symbols to avoid PRC font problem, DTK_FALSE : Using texts.
Definition: pdfw.hpp:188
Pdfw::cross_section::IntersectionColor
Dtk_RGB IntersectionColor
Definition: pdfw.hpp:26
Pdfw::WriteOptions::SplitLeaders
Dtk_bool SplitLeaders
DTK_TRUE : Splits leaders to text frames.
Definition: pdfw.hpp:190
Dtk_RGB
Definition: dtk_rgb.hpp:7
Pdfw::WriteOptions::TransparentBackground
Dtk_bool TransparentBackground
DTK_TRUE : Transparent Background, DTK_FALSE : Opaque Background.
Definition: pdfw.hpp:153
Pdfw::WriteOptions::SeparateActiveViews
Dtk_bool SeparateActiveViews
DTK_TRUE : Creates one 3d pdf annotation for each active view, DTK_FALSE : only one 3d annotation.
Definition: pdfw.hpp:143
Pdfw::WriteOptions::CreateDefaultView
Dtk_bool CreateDefaultView
DTK_TRUE : Creates Default View (isometric view), DTK_FALSE : no default view.
Definition: pdfw.hpp:139
Pdfw::WriteOptions::ShowToolbar
Dtk_bool ShowToolbar
DTK_TRUE : Show 3D Toolbar, DTK_FALSE : Hides 3D Toolbar.
Definition: pdfw.hpp:145