Exported APIs for PDF Write Library. More...

Namespaces
	Layout

Data Structures
struct	cross_section
	This structure provides several options to tune cross sections. It is a member of WriteOptions. More...

struct	LayoutOptions
	This structure provides several options to tune layout. It is a member of WriteOptions. More...

class	PdfDocumentProperties

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

Enumerations
enum	graphicinheritance { attributeoverwrite = 0x00, keepsubcolor = 0x01, keepsubtransparency = 0x02 }

enum	Lighting { NoLights = 0, LightsFromFile, WhiteLights, DayLights, BrightLights, PrimaryColorLights, NightLights, BlueLights, RedLights, CubeLights, CADOptimizedLights, HeadLamp, UnsetLighting = 255 }

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 }
	Model Render Mode in Acrobat. More...

Functions
Dtk_ErrorStatus	AddDocumentProperties (const Pdfw::PdfDocumentProperties &inDocProperties, const Dtk_tab< Dtk_MetaDataPtr > &inMetadatas)
	Writing Document Properties. More...

DtkErrorStatus	AddNodeMetadata (Dtk_tab< Dtk_MetaDataPtr > &inTabMetadata)
	Add table of metadata to current node. More...

DtkErrorStatus	AddNodeRenderInfo (Dtk_RenderInfosPtr inRenderInfos)
	Add rendering informations to current node. More...

DtkErrorStatus	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	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...

DtkErrorStatus	EndNode ()
	End the node. More...

DtkErrorStatus	EndWrite ()
	Creation of the output file and free the PDF Writer More...

DtkErrorStatus	InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo, const Dtk_bool &inVisi, Dtk_ID &outID)
	Initialize a node. More...

DtkErrorStatus	InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo, Dtk_InfoPtr &inInfo, Dtk_ID &outID)
	Initialize a node. More...

DtkErrorStatus	InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo, Dtk_InfoPtr &inInfo, Dtk_UChar8 inHeritStrategy, Dtk_ID &outID)
	Initialize a node. More...

DtkErrorStatus	InitNode (Dtk_string &inNodeName, const Dtk_transfo &inTransfo=Dtk_transfo())
	Initialize a node. More...

DtkErrorStatus	InitWrite (const Dtk_string &inOutputFile, const Dtk_string &inLogFile, Licence_dtk inLicFct, WriteOptions &inOptions)
	Initialize the PDF Writer More...

Dtk_bool	IsWriteInitialized ()
	Test if PDF Writer is initialized. More...

DtkErrorStatus	ReinstanciatePrototype (Dtk_ID inID)
	Reinstanciate children of node to reinstanciate in current node. More...

	SetAsDeprecated ("Undefined", "") Dtk_ErrorStatus WriteColoredPoints(Dtk_tab< Dtk_PointPtr > &inTabPoints

	SetAsDeprecated ("Undefined", "CreateModelDisplayWithVisibleNodes()") DtkErrorStatus CreateModelDisplay(Dtk_string &inName

	SetAsDeprecated ("Undefined", "Use CreateNodeConnectorHighlight()") Dtk_ErrorStatus CreateConnectorFdtFace(const Dtk_ID &inFdtID

void	StorePrototype (Dtk_ID inID)
	Stores the identifier of a node. More...

DtkErrorStatus	WriteBodyAndMesh (const Dtk_BodyPtr &inBody, const Dtk_MeshPtr &inMesh, Dtk_ID &outID)
	Write the entities provided in parameter in a node. More...

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())
	Write colored points provided in parameter in one node. More...

Dtk_ErrorStatus	WriteEntity (const Dtk_EntityPtr &inEntity)
	Write the entity provided in parameter in a node. More...

Dtk_ErrorStatus	WriteEntity (const Dtk_EntityPtr &inEntity, Dtk_ID &outID)
	Write the entity provided in parameter in a node. More...

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)
	Creates a parallel to screen picture with an attached leader line. More...

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)
	Deprecated function => Use WriteParallelToScreenPicture() or WritePinToScreenPicture() More...

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)
	Creates a picture parallel to screen with an attached leader line. More...

Dtk_ErrorStatus	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	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	inBackgroundColor = Dtk_RGB() )

Dtk_CameraPtr	inCamera

Dtk_CameraPtr Dtk_EntityPtr	inClippingEntity

const Dtk_tab< Dtk_ID > const Dtk_Size_t &	inFaceIndex

Dtk_tab< Dtk_dir > Dtk_ID Dtk_InfoPtr	inInfo = Dtk_InfoPtr() )

Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > Dtk_tab< Dtk_transfo > Dtk_RGB Dtk_bool	inManageHideShowBody

const Dtk_tab< Dtk_ID > &	inNodePathIDs

Dtk_tab< Dtk_dir > &	inTabNormals

Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > Dtk_tab< Dtk_transfo >	inTabTransfo = Dtk_tab<Dtk_transfo>()

Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > &	inTabVisibleNodes

Dtk_tab< Dtk_dir > Dtk_ID &	outID

Detailed Description

Exported APIs for PDF Write Library.

Enumeration Type Documentation

◆ graphicinheritance

enum Pdfw::graphicinheritance

Enumerator
attributeoverwrite
keepsubcolor
keepsubtransparency

      {
           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
      };

◆ Lighting

enum Pdfw::Lighting

Enumerator
NoLights
LightsFromFile
WhiteLights
DayLights
BrightLights
PrimaryColorLights
NightLights
BlueLights
RedLights
CubeLights
CADOptimizedLights
HeadLamp
UnsetLighting

      {
           NoLights = 0,
           LightsFromFile,
           WhiteLights,
           DayLights,
           BrightLights,
           PrimaryColorLights,
           NightLights,
           BlueLights,
           RedLights,
           CubeLights,
           CADOptimizedLights,
           HeadLamp,
           UnsetLighting = 255
      } Lighting;

◆ RenderMode

enum Pdfw::RenderMode

Model Render Mode in Acrobat.

Enumerator
Solid
SolidWireframe
Transparent
TransparentWireframe
BoundingBox
TransparentBoundingBox
TransparentBoundingBoxOutline
Wireframe
ShadedWireframe
HiddenWireframe
Vertices
ShadedVertices
Illustration
SolidOutline
ShadedIllustration
Unset

      {
           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;

Function Documentation

◆ AddDocumentProperties()

Dtk_ErrorStatus Pdfw::AddDocumentProperties	(	const Pdfw::PdfDocumentProperties &	inDocProperties,
		const Dtk_tab< Dtk_MetaDataPtr > &	inMetadatas
	)

Writing Document Properties.

Returns: dtkNoError if it is OK.

Parameters

[in]	inDocProperties	: Document Properties > Description
[in]	inMetadatas	: Document Properties > Custom Properties

Remarks: This function by default writes creation and modification date; It is optional

◆ AddNodeMetadata()

DtkErrorStatus Pdfw::AddNodeMetadata ( Dtk_tab< Dtk_MetaDataPtr > & inTabMetadata )

Add table of metadata to current node.

Parameters

[in] inTabMetadata : A Dtk_tab of Dtk_MetaDataPtr

Returns: dtkNoError if it is OK.

Remarks: You need to call this function just before EndNode() .

◆ AddNodeRenderInfo()

DtkErrorStatus Pdfw::AddNodeRenderInfo ( Dtk_RenderInfosPtr inRenderInfos )

Add rendering informations to current node.

Parameters

[in] inRenderInfos : A Dtk_RenderInfosPtr

Returns: dtkNoError if it is OK.

Remarks: The rendering information will be spread on all child nodes .

◆ CreateModelDisplayWithVisibleNodes()

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.

Parameters

[in]	inModelDisplay	: The model display to write
[in]	inTabVisibleNodes	: Table of referenced nodes (an empty table will mean that the view will reference all visible nodes)
[in]	inRenderMode	: Model display pdf render mode
[in]	inLighting	: Model display pdf extra lighting

Returns: dtkNoError if it is OK.

◆ CreateNodeConnectorHighlight()

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.

Parameters

[in]	inPointingNodeID	: The pdf identifier of the pointing node
[in]	inPointedNodeID	: The pdf identifier of the pointed node to be highlighted
[in]	inFaceIndex	: the index of the face in the mesh or body (optionnal)
[in]	inReasonLink	: Internal use only

◆ EndNode()

DtkErrorStatus Pdfw::EndNode ( )

End the node.

Returns: dtkNoError if it is OK.

◆ EndWrite()

DtkErrorStatus Pdfw::EndWrite ( )

Creation of the output file and free the PDF Writer

Returns: dtkNoError if it is OK.

Remarks: used as the last function used for the writer.

◆ InitNode() [1/4]

DtkErrorStatus Pdfw::InitNode	(	Dtk_string &	inNodeName,
		const Dtk_transfo &	inTransfo,
		const Dtk_bool &	inVisi,
		Dtk_ID &	outID
	)

Initialize a node.

Parameters

[in]	inNodeName	: The name of the node
[in]	inTransfo	: The matrix of the node
[in]	inVisi	: The visibility of the node (1 : visible, 0 : invisible)
[out]	outID	: The identifier of the node

Returns: dtkNoError if it is OK.

Remarks: The node is set as current node children .; To close the node you will need to call EndNode() function .

◆ InitNode() [2/4]

DtkErrorStatus Pdfw::InitNode	(	Dtk_string &	inNodeName,
		const Dtk_transfo &	inTransfo,
		Dtk_InfoPtr &	inInfo,
		Dtk_ID &	outID
	)

Initialize a node.

Parameters

[in]	inNodeName	: The name of the node
[in]	inTransfo	: The matrix of the node
[in]	inInfo	: The infos (attributes) of the node
[out]	outID	: The identifier of the node

Returns: dtkNoError if it is OK.

Remarks: The node is set as current node children .; All graphical attributes contained in Dtk_InfoPtr such as color or render infos will overload entities attributes .; To close the node you will need to call EndNode() function .

◆ InitNode() [3/4]

DtkErrorStatus Pdfw::InitNode	(	Dtk_string &	inNodeName,
		const Dtk_transfo &	inTransfo,
		Dtk_InfoPtr &	inInfo,
		Dtk_UChar8	inHeritStrategy,
		Dtk_ID &	outID
	)

Initialize a node.

Parameters

[in]	inNodeName	: The name of the node
[in]	inTransfo	: The matrix of the node
[in]	inInfo	: The infos (attributes) of the node
[in]	inHeritStrategy	: strategy for graphic attributes (Dtk_RGB / Dtk_RenderInfos) inheritance multiple values can be set (bit vector). E.g. : Pdfw::keepsubcolor \| Pdfw::keepsubtransparency
[out]	outID	: The identifier of the node

Returns: dtkNoError if it is OK.

Remarks: The node is set as current node children .; All graphical attributes contained in Dtk_InfoPtr such as color or render infos will overload entities attributes .; To close the node you will need to call EndNode() function .

◆ InitNode() [4/4]

DtkErrorStatus Pdfw::InitNode	(	Dtk_string &	inNodeName,
		const Dtk_transfo &	inTransfo = `Dtk_transfo()`
	)

Initialize a node.

Parameters

[in]	inNodeName	: The name of the node
[in]	inTransfo	: The matrix of the node

Returns: dtkNoError if it is OK.

Remarks: The node is set as current node children .; To close the node you will need to call EndNode() function .

◆ InitWrite()

DtkErrorStatus Pdfw::InitWrite	(	const Dtk_string &	inOutputFile,
		const Dtk_string &	inLogFile,
		Licence_dtk	inLicFct,
		WriteOptions &	inOptions
	)

Initialize the PDF Writer

Returns: dtkNoError if it is OK.

Parameters

[in]	inOutputFile	: Output file name
[in]	inLogFile	: Log file
[in]	inLicFct	: License function or Null
[in]	inOptions	: Options

Remarks: This function is the first call for the writer, it must me called after Dtk_API::StartAPI(...)

◆ IsWriteInitialized()

Dtk_bool Pdfw::IsWriteInitialized ( )

Test if PDF Writer is initialized.

Returns: DTK_TRUE if it is initialized, DTK_FALSE if not

◆ ReinstanciatePrototype()

DtkErrorStatus Pdfw::ReinstanciatePrototype ( Dtk_ID inID )

Reinstanciate children of node to reinstanciate in current node.

Parameters

[in] inID : A unique identifier of the node to be reinstanciated

Returns: dtkNoError if it is OK.

◆ SetAsDeprecated() [1/3]

Pdfw::SetAsDeprecated	(	"Undefined"	,
		""
	)		&

◆ SetAsDeprecated() [2/3]

Pdfw::SetAsDeprecated	(	"Undefined"	,
		"CreateModelDisplayWithVisibleNodes()"
	)		&

Deprecated:: => Use CreateModelDisplayWithVisibleNodes()

Deprecated:: => Use CreateModelDisplayWithVisibleNodes()

◆ SetAsDeprecated() [3/3]

Pdfw::SetAsDeprecated	(	"Undefined"	,
		"Use CreateNodeConnectorHighlight()"
	)		const &

Deprecated:: => Use CreateNodeConnectorHighlight()

◆ StorePrototype()

void Pdfw::StorePrototype ( Dtk_ID inID )

Stores the identifier of a node.

Parameters

[in] inID : A unique identifier of the node

◆ WriteBodyAndMesh()

DtkErrorStatus Pdfw::WriteBodyAndMesh	(	const Dtk_BodyPtr &	inBody,
		const Dtk_MeshPtr &	inMesh,
		Dtk_ID &	outID
	)

Write the entities provided in parameter in a node.

Parameters

[in]	inBody	: The Body to be written
[in]	inMesh	: The corresponding mesh to be written
[out]	outID	: The ID of the written entity

Returns: dtkNoError if it is OK.

Remarks: This function is used to write entities .; The entity is stored in current node .

◆ WriteColoredPoints()

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.

Parameters

[in]	inTabPoints	: The points to be written with their color ( point->info()->SetColor( Dtk_RGB() ); )
[in]	inTabNormals	: The normals to be written (Optional)
[in]	inTabColors	: The colors to be written (Optional)
[out]	outID	: The ID of the written entities
[in]	inInfos	: The infos of the written entities

Returns: dtkNoError if it is OK.

Remarks: The entity is stored in current node .; Normals are not handled by acrobat reader

◆ WriteEntity() [1/2]

Dtk_ErrorStatus Pdfw::WriteEntity ( const Dtk_EntityPtr & inEntity )

Write the entity provided in parameter in a node.

Parameters

[in] inEntity : The Entity to be written

Returns: dtkNoError if it is OK.

Remarks: This function is used to write entities; (It can be Dtk_BodyPtr, Dtk_MeshPtr, Dtk_CurvePtr, Dtk_PointPtr, Dtk_FdtPtr, Dtk_ModelDisplayPtr, Dtk_AxisSystemPtr or Dtk_CameraPtr) .; The entity is stored in current node .

◆ WriteEntity() [2/2]

Dtk_ErrorStatus Pdfw::WriteEntity	(	const Dtk_EntityPtr &	inEntity,
		Dtk_ID &	outID
	)

Write the entity provided in parameter in a node.

Parameters

[in]	inEntity	: The Entity to be written
[out]	outID	: The ID of the written entity

Returns: dtkNoError if it is OK.

Remarks: This function is used to write entities; (It can be Dtk_BodyPtr, Dtk_MeshPtr, Dtk_CurvePtr, Dtk_PointPtr, Dtk_FdtPtr, Dtk_ModelDisplayPtr, Dtk_AxisSystemPtr or Dtk_CameraPtr) .; The entity is stored in current node .

◆ WriteParallelToScreenPicture()

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.

Parameters

[in]	inPictureFilePath	: Picture file path
[in]	inPictureWidth	: Picture width (mm)
[in]	inPictureHeight	: Picture height (mm)
[in]	inAnchorType	: Picture / Leader end anchor point
[in]	inIsZoomable	: Is zoomable attribute
[in]	inIsOnTop	: Is on top attribute
[in]	inTransfo	: 3d transfo
[in]	inLeader	: 2d leader

Returns: dtkNoError if it is OK.

Remarks: : Supported picture formats are : JPG/PNG/BMP/PSD/TGA/GIF/HDR/PIC/PNM/TIFF; : returns dtkErrorCannotCompute when no page have been initialised

◆ WritePictureWithLeaderLine()

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()

Create a picture parallel or pin to screen with an attached leader line

Parameters

[in]	inPictureFilePath	: Picture file path
[in]	inPictureWidth	: Picture width (mm)
[in]	inPictureHeight	: Picture height (mm)
[in]	inAnchorType	: Picture / Leader anchor point (future use)
[in]	inScreenDisplayAttrib	: Screen display attribute (ParallelToScreen or PinToScreen)
[in]	inIsZoomable	: Is zoomable attribute
[in]	inIsOnTop	: Is on top attribute
[in]	inPictureOrigin	: 2d picture origin
[in]	inTransfo	: 3d picture transfo
[in]	inTabEntities	: Additional geometries

Returns: dtkNoError if it is OK.

Remarks: : Supported picture formats are : JPEG baseline (no JPEG progressive), PNG 8-bit-per-channel only
BMP non-1bpp, non-RLE and GIF (*comp always reports as 4-channel)

◆ WritePinToScreenPicture()

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.

Parameters

[in]	inPictureFilePath	: Picture file path
[in]	inPictureWidth	: Picture width (mm)
[in]	inPictureHeight	: Picture height (mm)
[in]	inPictureOrigin	: 2d picture origin (offset point from 3d annotation bottom left corner in mm)
[in]	inAnchorType	: Picture / Leader anchor point
[in]	inIsOnTop	: Is on top attribute
[in]	inLeader	: Leader

Returns: dtkNoError if it is OK.

Remarks: : Supported picture formats are : JPG/PNG/BMP/PSD/TGA/GIF/HDR/PIC/PNM/TIFF; : Needs Layout::_3DAnnotSize[4] to be filled (when 3d annotation is smaller than current pdf page); : returns dtkErrorCannotCompute when no page have been initialised

◆ WritePoints()

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.

Parameters

[in]	inTabPoints	: The points to be written
[out]	outID	: The ID of the written entities
[in]	inInfos	: The infos of the written entities

Returns: dtkNoError if it is OK.

Remarks: The entity is stored in current node .; Only first color of points is handled and spread to all points

◆ WritePolylines()

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.

Parameters

[in]	inEntity	: The polylines to be written
[out]	outID	: The ID of the written entity
[in]	inInfos	: The infos of the written entities

Returns: dtkNoError if it is OK.

Remarks: The entity is stored in current node .

Variable Documentation

◆ inBackgroundColor

Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > Dtk_tab< Dtk_transfo > Dtk_RGB Pdfw::inBackgroundColor = Dtk_RGB() )

◆ inCamera

Dtk_CameraPtr Pdfw::inCamera

◆ inClippingEntity

Dtk_CameraPtr Dtk_EntityPtr Pdfw::inClippingEntity

◆ inFaceIndex

const Dtk_tab<Dtk_ID> const Dtk_Size_t& Pdfw::inFaceIndex

◆ inInfo

Dtk_tab< Dtk_dir > Dtk_ID Dtk_InfoPtr Pdfw::inInfo = Dtk_InfoPtr() )

◆ inManageHideShowBody

Dtk_CameraPtr Dtk_EntityPtr Dtk_tab<Dtk_ID> Dtk_tab<Dtk_transfo> Dtk_RGB Dtk_bool Pdfw::inManageHideShowBody

◆ inNodePathIDs

const Dtk_tab<Dtk_ID>& Pdfw::inNodePathIDs

◆ inTabNormals

Dtk_tab< Dtk_dir >& Pdfw::inTabNormals

◆ inTabTransfo

Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > Dtk_tab< Dtk_transfo > & Pdfw::inTabTransfo = Dtk_tab<Dtk_transfo>()

◆ inTabVisibleNodes

Dtk_CameraPtr Dtk_EntityPtr Dtk_tab< Dtk_ID > & Pdfw::inTabVisibleNodes

◆ outID

Dtk_tab< Dtk_dir > Dtk_ID& Pdfw::outID

Namespaces

Data Structures

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

◆ graphicinheritance

◆ Lighting

◆ RenderMode

Function Documentation

◆ AddDocumentProperties()

◆ AddNodeMetadata()

◆ AddNodeRenderInfo()

◆ CreateModelDisplayWithVisibleNodes()

◆ CreateNodeConnectorHighlight()

◆ EndNode()

◆ EndWrite()

◆ InitNode() [1/4]

◆ InitNode() [2/4]

◆ InitNode() [3/4]

◆ InitNode() [4/4]

◆ InitWrite()

◆ IsWriteInitialized()

◆ ReinstanciatePrototype()

◆ SetAsDeprecated() [1/3]

◆ SetAsDeprecated() [2/3]

◆ SetAsDeprecated() [3/3]

◆ StorePrototype()

◆ WriteBodyAndMesh()

◆ WriteColoredPoints()

◆ WriteEntity() [1/2]

◆ WriteEntity() [2/2]

◆ WriteParallelToScreenPicture()

◆ WritePictureWithLeaderLine()

◆ WritePinToScreenPicture()

◆ WritePoints()

◆ WritePolylines()

Variable Documentation

◆ inBackgroundColor

◆ inCamera

◆ inClippingEntity

◆ inFaceIndex

◆ inInfo

◆ inManageHideShowBody

◆ inNodePathIDs

◆ inTabNormals

◆ inTabTransfo

◆ inTabVisibleNodes

◆ outID