DATAKIT API  V2025.1
pdfw.hpp File Reference

Go to the source code of this file.

Data Structures

struct  Pdfw::cross_section
 This structure provides several options to tune cross sections.
It is a member of WriteOptions. More...
 
struct  Pdfw::LayoutOptions
 This structure provides several options to tune layout.
It is a member of WriteOptions. More...
 
class  Pdfw::PdfDocumentProperties
 
class  Pdfw::WriteOptions
 This class provides several options to tune Pdf Writer.
It must be provided to Pdfw::InitWrite method. More...
 

Namespaces

 Layout
 This namespace provides several methods for pdf layout management.
.
 
 Pdfw
 Exported APIs for PDF Write Library.
 
 Pdfw::Layout
 

Enumerations

enum  Pdfw::graphicinheritance { Pdfw::attributeoverwrite = 0x00, Pdfw::keepsubcolor = 0x01, Pdfw::keepsubtransparency = 0x02 }
 
enum  Pdfw::Lighting {
  Pdfw::NoLights = 0, Pdfw::LightsFromFile, Pdfw::WhiteLights, Pdfw::DayLights,
  Pdfw::BrightLights, Pdfw::PrimaryColorLights, Pdfw::NightLights, Pdfw::BlueLights,
  Pdfw::RedLights, Pdfw::CubeLights, Pdfw::CADOptimizedLights, Pdfw::HeadLamp,
  Pdfw::UnsetLighting = 255
}
 
enum  Pdfw::Layout::PageDirection { Pdfw::Layout::PORTRAIT = 0, Pdfw::Layout::LANDSCAPE }
 
enum  Pdfw::Layout::PageSizes {
  Pdfw::Layout::SIZE_LETTER = 0, Pdfw::Layout::SIZE_LEGAL, Pdfw::Layout::SIZE_A3, Pdfw::Layout::SIZE_A4,
  Pdfw::Layout::SIZE_A5, Pdfw::Layout::SIZE_B4, Pdfw::Layout::SIZE_B5, Pdfw::Layout::SIZE_EXECUTIVE,
  Pdfw::Layout::SIZE_US4x6, Pdfw::Layout::SIZE_US4x8, Pdfw::Layout::SIZE_US5x7, Pdfw::Layout::SIZE_COMM10,
  Pdfw::Layout::SIZE_EOF
}
 
enum  Pdfw::RenderMode {
  Pdfw::Solid = 0, Pdfw::SolidWireframe = 1, Pdfw::Transparent = 2, Pdfw::TransparentWireframe = 3,
  Pdfw::BoundingBox = 4, Pdfw::TransparentBoundingBox = 5, Pdfw::TransparentBoundingBoxOutline = 6, Pdfw::Wireframe = 7,
  Pdfw::ShadedWireframe = 8, Pdfw::HiddenWireframe = 9, Pdfw::Vertices = 10, Pdfw::ShadedVertices = 11,
  Pdfw::Illustration = 12, Pdfw::SolidOutline = 13, Pdfw::ShadedIllustration = 14, Pdfw::Unset = 255
}
 Model Render Mode in Acrobat. More...
 

Functions

Dtk_ErrorStatus Pdfw::AddDocumentProperties (const Pdfw::PdfDocumentProperties &inDocProperties, const Dtk_tab< Dtk_MetaDataPtr > &inMetadatas)
 Writing Document Properties. More...
 
DtkErrorStatus Pdfw::AddNodeMetadata (Dtk_tab< Dtk_MetaDataPtr > &inTabMetadata)
 Add table of metadata to current node. More...
 
DtkErrorStatus Pdfw::AddNodeRenderInfo (Dtk_RenderInfosPtr inRenderInfos)
 Add rendering informations to current node. More...
 
DtkErrorStatus Pdfw::Layout::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)
 Creates 3D Annotation from 3D artwork in current page with its 2d bounding box. More...
 
DtkErrorStatus Pdfw::CreateModelDisplayWithVisibleNodes (Dtk_ModelDisplayPtr &inModelDisplay, Dtk_tab< Dtk_ID > &inTabVisibleNodes, Pdfw::RenderMode inRenderMode=Pdfw::Unset, Pdfw::Lighting inLighting=Pdfw::UnsetLighting)
 Create a model display. More...
 
Dtk_ErrorStatus Pdfw::CreateNodeConnectorHighlight (const Dtk_ID &inPointingNodeID, const Dtk_ID &inPointedNodeID, const Dtk_UInt32 &inFaceIndex=-1, Dtk_Int32 inReasonLink=0)
 Create a connexion between two nodes for visual response. More...
 
Dtk_ErrorStatus Pdfw::Layout::CreateOutline (Dtk_string inName)
 Creation of outline. More...
 
DtkErrorStatus Pdfw::Layout::End3DArtwork (Dtk_UInt32 &outartworkIndex)
 Ends Writing of 3D Artwork. More...
 
DtkErrorStatus Pdfw::EndNode ()
 End the node. More...
 
Dtk_ErrorStatus Pdfw::Layout::EndPage ()
 End of page. More...
 
DtkErrorStatus Pdfw::EndWrite ()
 Creation of the output file and free the PDF Writer
More...
 
Dtk_ErrorStatus Pdfw::Layout::FillRectangle (Dtk_Double64 inBBox[4], Dtk_RGB inColor)
 Fills a rectangle area with color. More...
 
DtkErrorStatus Pdfw::Layout::Get3DArtworkBBox (Dtk_pnt &outPmin, Dtk_pnt &outPmax)
 Gets oriented XYZ bounding box corners. More...
 
Dtk_Double64 Pdfw::Layout::GetCurrentPageHeight ()
 Gets current page height. More...
 
Dtk_Double64 Pdfw::Layout::GetCurrentPageWidth ()
 Gets current page width. More...
 
DtkErrorStatus Pdfw::Layout::Init3DArtwork (Dtk_string inAnnotName=Dtk_string(), Pdfw::WriteOptions *inWriteOptions=NULL)
 Starts Writing of 3D Artwork (3D model) More...
 
DtkErrorStatus Pdfw::InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo, const Dtk_bool &inVisi, Dtk_ID &outID)
 Initialize a node. More...
 
DtkErrorStatus Pdfw::InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo, Dtk_InfoPtr &inInfo, Dtk_ID &outID)
 Initialize a node. More...
 
DtkErrorStatus Pdfw::InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo, Dtk_InfoPtr &inInfo, Dtk_UChar8 inHeritStrategy, Dtk_ID &outID)
 Initialize a node. More...
 
DtkErrorStatus Pdfw::InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo=Dtk_transfo())
 Initialize a node. More...
 
Dtk_ErrorStatus Pdfw::Layout::InitPage (Dtk_RGB inColor=Dtk_RGB(255, 255, 255), Dtk_Double64 inWidth=842, Dtk_Double64 inHeight=595)
 LAYOUT METHODS. More...
 
DtkErrorStatus Pdfw::InitWrite (const Dtk_string &inOutputFile, const Dtk_string &inLogFile, Licence_dtk inLicFct, WriteOptions &inOptions)
 Initialize the PDF Writer
More...
 
Dtk_bool Pdfw::IsWriteInitialized ()
 Test if PDF Writer is initialized. More...
 
DtkErrorStatus Pdfw::ReinstanciatePrototype (Dtk_ID inID)
 Reinstanciate children of node to reinstanciate in current node. More...
 
 Pdfw::SetAsDeprecated ("Undefined", "") Dtk_ErrorStatus WriteColoredPoints(Dtk_tab< Dtk_PointPtr > &inTabPoints
 
 Pdfw::SetAsDeprecated ("Undefined", "CreateModelDisplayWithVisibleNodes()") DtkErrorStatus CreateModelDisplay(Dtk_string &inName
 
 Pdfw::SetAsDeprecated ("Undefined", "Use CreateNodeConnectorHighlight()") Dtk_ErrorStatus CreateConnectorFdtFace(const Dtk_ID &inFdtID
 
Dtk_ErrorStatus Pdfw::Layout::SetCurrentPageSize (Dtk_Double64 inWidth, Dtk_Double64 inHeight)
 Sets current page size. More...
 
Dtk_ErrorStatus Pdfw::Layout::SetCurrentPageSize (PageSizes inSize, PageDirection inDirection)
 Sets current page size. More...
 
void Pdfw::StorePrototype (Dtk_ID inID)
 Stores the identifier of a node. More...
 
DtkErrorStatus Pdfw::WriteBodyAndMesh (const Dtk_BodyPtr &inBody, const Dtk_MeshPtr &inMesh, Dtk_ID &outID)
 Write the entities provided in parameter in a node. More...
 
Dtk_ErrorStatus Pdfw::WriteColoredPoints (Dtk_tab< Dtk_pnt > &inTabPoints, Dtk_tab< Dtk_dir > &inTabNormals, Dtk_tab< Dtk_RGB > &inTabColors, Dtk_ID &outID, Dtk_InfoPtr inInfo=Dtk_InfoPtr())
 Write colored points provided in parameter in one node. More...
 
Dtk_ErrorStatus Pdfw::Layout::WriteCompositeText (Dtk_CompositeText &inCompositeText)
 Write a composite text. More...
 
Dtk_ErrorStatus Pdfw::WriteEntity (const Dtk_EntityPtr &inEntity)
 Write the entity provided in parameter in a node. More...
 
Dtk_ErrorStatus Pdfw::WriteEntity (const Dtk_EntityPtr &inEntity, Dtk_ID &outID)
 Write the entity provided in parameter in a node. More...
 
Dtk_ErrorStatus Pdfw::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)
 Creates a parallel to screen picture with an attached leader line. More...
 
Dtk_ErrorStatus Pdfw::Layout::WritePicture (Dtk_string inPicturePath, Dtk_Double64 inPictureBBox[4])
 Write a picture. More...
 
Dtk_ErrorStatus Pdfw::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)
 Deprecated function => Use WriteParallelToScreenPicture() or WritePinToScreenPicture() More...
 
Dtk_ErrorStatus Pdfw::WritePinToScreenPicture (const Dtk_string &inPictureFilePath, Dtk_Double64 inPictureWidth, Dtk_Double64 inPictureHeight, Dtk_pnt inPictureOrigin, Dtk_anchor_type inAnchorType, bool inIsOnTop, Dtk_LeaderPtr &inLeader)
 Creates a picture parallel to screen with an attached leader line. More...
 
Dtk_ErrorStatus Pdfw::WritePoints (Dtk_tab< Dtk_PointPtr > &inTabPoints, Dtk_ID &outID, Dtk_InfoPtr inInfo=Dtk_InfoPtr())
 Write points provided in parameter in one node. More...
 
Dtk_ErrorStatus Pdfw::Layout::WritePolylines (Dtk_tab< Dtk_PolylinePtr > &inTabPolylines)
 Write a set of polylines. More...
 
Dtk_ErrorStatus Pdfw::WritePolylines (Dtk_tab< Dtk_PolylinePtr > &inTabPolylines, Dtk_ID &outID, Dtk_InfoPtr inInfo=Dtk_InfoPtr())
 Write polylines provided in parameter in one node. More...
 

Variables

Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > Dtk_tab< Dtk_transfo > Dtk_RGB Pdfw::inBackgroundColor = Dtk_RGB() )
 
Dtk_CameraPtr Pdfw::inCamera
 
Dtk_CameraPtr Dtk_EntityPtr Pdfw::inClippingEntity
 
const Dtk_tab< Dtk_ID > const Dtk_Size_tPdfw::inFaceIndex
 
Dtk_tab< Dtk_dir > Dtk_ID Dtk_InfoPtr Pdfw::inInfo = Dtk_InfoPtr() )
 
Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > Dtk_tab< Dtk_transfo > Dtk_RGB Dtk_bool Pdfw::inManageHideShowBody
 
const Dtk_tab< Dtk_ID > & Pdfw::inNodePathIDs
 
Dtk_tab< Dtk_dir > & Pdfw::inTabNormals
 
Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > Dtk_tab< Dtk_transfoPdfw::inTabTransfo = Dtk_tab<Dtk_transfo>()
 
Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > & Pdfw::inTabVisibleNodes
 
Dtk_tab< Dtk_dir > Dtk_IDPdfw::outID