| SoToPDFAction Class |
Class for exporting a scene graph to a PDF file.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.Inventor.ActionsSoAction
OIV.Inventor.ActionsSoCallbackAction
OIV.HardCopySoToU3DAction
OIV.HardCopySoToPDFAction
Namespace: OIV.HardCopy
Assembly: OIV.HardCopy (in OIV.HardCopy.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoToPDFAction type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoToPDFAction | Initializes a new instance of the SoToPDFAction class |
Methods| Name | Description | |
|---|---|---|
| AddLineSegmentCallback | Routine to add callbacks for generated primitives (line segments) for all shapes of the given type. |
| AddPointCallback | Routine to add callbacks for generated primitives (points) for all shapes of the given type. |
| AddPostCallback | Adds a callback function to call when a node of the given type is encountered during traversal. |
| AddPreCallback | Adds a callback function to call when a node of the given type is encountered during traversal. |
| AddTriangleCallback | Routine to add callbacks for generated primitives (triangles) for all shapes of the given type. |
| Apply(SoNode) | Initiates an action on the graph specified by a node. |
| Apply(SoPath) | Initiates an action on the graph specified by a path. |
| Apply(SoPathList) | Calls Apply(pathList, false). (Inherited from SoToU3DAction.) |
| Apply(SoPathList, Boolean) | Initiates an action on the graph specified by list of paths. |
| AreDraggersExported | Returns true if draggers are exported. |
| ClearApplyResult | When applied, an action may reference nodes or create objects (e.g. |
| CloseFile | finalize export to the U3D output file. |
 | EnableElement | |
| EnableElements | (Overrides SoToU3DActionEnableElements.) |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| ForcePolygonalText3 | Forces OIV.Inventor.Nodes.SoText2 nodes to be exported using OIV.Inventor.Nodes.SoText3 (default is true). |
| ForwardTraversal(SoNode) | Traverse a node that is not part of the current scenegraph. |
| ForwardTraversal(SoPath) | Traverse a node that is not part of the current scenegraph. |
| GetComplexity | Returns complexity information from the state. |
| GetComplexityType | Returns complexity information from the state. |
| GetContinueActionInBranchFlag | This function indicates if the action must stop in the current branch. |
| GetCoordinate3 | Returns the current coordinates from the state. |
| GetCoordinate4 | Returns the current coordinates from the state. |
| GetCreaseAngle | Returns the current shape hints from the state. |
| GetCurPath | Returns the path accumulated during traversal, i.e., the chain of nodes from the root of the traversed graph to the current node being traversed. |
| GetCurrentResponse | (Inherited from SoCallbackAction.) |
| GetDecimationPercentage | Returns the current decimation percentage from the state. |
| GetDecimationType | Returns the current decimation type from the state. |
| GetDistribMode | Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only). |
| GetDrawStyle | Returns the current drawing style information from the state. |
| GetFaceType | Returns the current shape hints from the state. |
| GetFocalDistance | Returns the current camera and viewing information from the state. |
| GetFontName | Returns the current font information from the state. |
| GetFontRenderStyle | Returns the current font information from the state. |
| GetFontSize | Returns the current font information from the state. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetLightAttenuation | Returns the current lighting model information from the state. |
| GetLightModel | Returns the current lighting model information from the state. |
| GetLinePattern | Returns the current drawing style information from the state. |
| GetLinePatternScaleFactor | Returns the current drawing style information from the state. |
| GetLineWidth | Returns the current drawing style information from the state. |
| GetMaterial(SbColor, SbColor, SbColor, SbColor, Single, Single) | Calls GetMaterial(ambient, diffuse, specular, emission, shininess, transparency, System.Int32(0)). (Inherited from SoCallbackAction.) |
| GetMaterial(SbColor, SbColor, SbColor, SbColor, Single, Single, Int32) | Returns the current material information from the state. |
| GetMaterialBinding | Returns the current material information from the state. |
| GetModelMatrix | Returns the current modeling transformation from the state. |
| GetNodeAppliedTo | Returns the node the action is being applied to. |
| GetNormal | Returns the current normal information from the state. |
| GetNormalBinding | Returns the current normal information from the state. |
| GetNumCoordinates | Returns the current coordinates from the state. |
| GetNumNormals | Returns the current normal information from the state. |
| GetNumProfileCoordinates | Returns the current profiles and their coordinates from the state. |
| GetNumTextureCoordinates | Returns texture information from the state. |
| GetOriginalPathListAppliedTo | Returns the original path list the action is being applied to. |
| GetPathAppliedTo | Returns the path the action is being applied to. |
| GetPathCode | Returns path code based on where current node (the node at the end of the current path) lies with respect to the path(s) the action is being applied to. |
| GetPathListAppliedTo | Returns the path list the action is being applied to. |
| GetPickStyle | Returns the current picking style. |
| GetPipeId | Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. |
| GetPointSize | Returns the current drawing style information from the state. |
| GetProfile | Returns the current profiles and their coordinates from the state. |
| GetProfileCoordinate2 | Returns the current profiles and their coordinates from the state. |
| GetProfileCoordinate3 | Returns the current profiles and their coordinates from the state. |
| GetProjectionMatrix | Returns the current camera and viewing information from the state. |
| GetSceneManager | Return the OIV.Inventor.SoSceneManager associated with this action. |
| GetShapeType | Returns the current shape hints from the state. |
| GetState | Gets the state from the action. |
| GetSwitch | Returns the current switch value. |
| GetTextureBlendColor | Returns texture information from the state. |
| GetTextureCoordinate2 | Returns texture information from the state. |
| GetTextureCoordinate4 | Returns texture information from the state. |
| GetTextureCoordinateBinding | Returns texture information from the state. |
| GetTextureFileName | Returns texture information from the state. |
| GetTextureImage(SbVec2i32, Int32) | Returns texture information from the state. |
| GetTextureImage(SbVec2s, Int32) | Obsolete. Returns texture information from the state. |
| GetTextureMatrix | Returns the current texture mapping information from the state. |
| GetTextureModel | Returns the current texture mapping information from the state. |
| GetTextureTransformNode | Returns the current texture mapping information from the state. |
| GetTextureWrapS | Returns the current texture mapping information from the state. |
| GetTextureWrapT | Returns the current texture mapping information from the state. |
| GetTransparencyType | Returns the current Transparency Type information from the state. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUnits | Returns the current units from the state. |
| GetVertexOrdering | Returns the current shape hints from the state. |
| GetViewingMatrix | Returns the current camera and viewing information from the state. |
| GetViewVolume | Returns the current camera and viewing information from the state. |
| GetWhatAppliedTo | Returns code indicating what action is being applied to. |
| HasTerminated | Returns true if the traversal has reached a termination condition. |
| InvalidateState | Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied. |
| InvokePostCallbacks | (Inherited from SoCallbackAction.) |
| InvokePreCallbacks | (Inherited from SoCallbackAction.) |
| IsBeingApplied | Returns true if this action is currently being applied. |
| IsCallbackAll | Returns whether the callback uses normal traversal (switches, etc.) or whether it traverses every single node. |
| IsLastPathListAppliedTo | Returns true if the current list is the last one from the original. |
| IsPolygonalText3Forced | Returns true if polygonal text3 is forced (see forcePolygonalText3). |
| IsUsingAlternateRep | Returns true if current action is using alternate representations. |
| OpenFile | Set the PDF output file. |
| PostDelayedTraversal | Method called by SoMultiPassManager after delayed pass traversals. |
| PreDelayedTraversal | Method called by SoMultiPassManager before delayed pass traversals. |
| ResetContinueActionInBranchFlag | This function resets the continue action flag. |
| SetCallbackAll | Sets whether the callback uses normal traversal (switches, etc.) or whether it traverses every single node. |
| SetExportDraggers | Allow the export of draggers (default is true). |
| SetLandscape | [Optional] Changes the page orientation from portrait to landscape. |
| SetPassword(String) | Calls SetPassword(writePass, (System.String ^)nullptr). |
| SetPassword(String, String) | [Optional] Set passwords to lock write & read access to the PDF file contents. |
| SetPipeId | Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. |
| SetSceneManager | Set the scene manager associated with this action (if any ). |
| SetText | [Optional] Add a text block into the output PDF file. |
| SetTitle | [Optional] Set a title into the output PDF file. |
| SetUpState | Creates state if it is NULL or it is no longer valid because new elements have been enabled since it was created. |
| ShouldGeneratePrimitives | (Inherited from SoCallbackAction.) |
| StopActionInBranch | This function stops the action in the current Scene Graph branch. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Traverse | Does traversal of a graph rooted by a node. |
| UseAlternateRep | Tell the action to use alternate representations during traversal when available. |
Events| Name | Description | |
|---|---|---|
 | PostTailTraversal | (Inherited from SoCallbackAction.) |
| PreTailTraversal | (Inherited from SoCallbackAction.) |
RemarksThis class can export an Open Inventor scenegraph into a simple PDF file. In addition to 3D scene encapsulation, the exporter can insert a title to the document and an unique block of text. Moreover, PDF encryption can lock access to the file contents. To import a 3D model inside a more complex PDF file, prefer OIV.HardCopy.SoToU3DAction. U3D files can be used to import 3D models inside PDF files by advanced PDF editors.
Limitations
Inherits limitations of OIV.HardCopy.SoToU3DAction. Please read these carefully.
Use case
SoSeparator root = new SoSeparator(); ... SoToPDFAction pdfAction = new SoToPDFAction(); bool result = pdfAction.OpenFile( "output.pdf" ); if ( !result ) { // error management } pdfAction.SetTitle( "Scene Name" ); pdfAction.SetText( "Some text describing the exported scene." ); pdfAction.Apply( root ); result = pdfAction.CloseFile(); if ( !result ) { // error management }
Warning
On some platforms, some third parties may encounter problems to load displaying an error message like: "IFXOSFileIterator.ProcessDir: error opening /usr/local/u3d/lib/Plugins/ No such file or directory". In such case, declare the environment variable U3D_LIBDIR (UNIX only) and set it with the path to the Open Inventor libraries ($OIVHOME/lib).
Limitations are common to OIV.HardCopy.SoToU3DAction.
See Also