SoToPDFAction Class

SoToPDFAction Class

Class for exporting a scene graph to a PDF file.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.ActionsSoAction
      OIV.Inventor.ActionsSoCallbackAction
        OIV.HardCopySoToU3DAction
          OIV.HardCopySoToPDFAction

Namespace: OIV.HardCopy
Assembly: OIV.HardCopy (in OIV.HardCopy.dll) Version: 10.12.3.0 (10.12.3.0)

Syntax

C++

Copy

public class SoToPDFAction : SoToU3DAction

Public Class SoToPDFAction
	Inherits SoToU3DAction

public ref class SoToPDFAction : public SoToU3DAction

type SoToPDFAction =  
    class
        inherit SoToU3DAction
    end

The SoToPDFAction type exposes the following members.

Constructors

	Name	Description
	SoToPDFAction	Initializes a new instance of the SoToPDFAction class

Top

Methods

	Name	Description
	AddLineSegmentCallback	Routine to add callbacks for generated primitives (line segments) for all shapes of the given type. (Inherited from SoCallbackAction.)
	AddPointCallback	Routine to add callbacks for generated primitives (points) for all shapes of the given type. (Inherited from SoCallbackAction.)
	AddPostCallback	Adds a callback function to call when a node of the given type is encountered during traversal. (Inherited from SoCallbackAction.)
	AddPreCallback	Adds a callback function to call when a node of the given type is encountered during traversal. (Inherited from SoCallbackAction.)
	AddTriangleCallback	Routine to add callbacks for generated primitives (triangles) for all shapes of the given type. (Inherited from SoCallbackAction.)
	Apply(SoNode)	Initiates an action on the graph specified by a node. (Inherited from SoToU3DAction.)
	Apply(SoPath)	Initiates an action on the graph specified by a path. (Inherited from SoToU3DAction.)
	Apply(SoPathList)	Calls Apply(pathList, false). (Inherited from SoToU3DAction.)
	Apply(SoPathList, Boolean)	Initiates an action on the graph specified by list of paths. (Inherited from SoToU3DAction.)
	AreDraggersExported	Returns true if draggers are exported. (Inherited from SoToU3DAction.)
	ClearApplyResult	When applied, an action may reference nodes or create objects (e.g. (Inherited from SoAction.)
	CloseFile	finalize export to the U3D output file. (Overrides SoToU3DActionCloseFile.)
	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). (Inherited from SoToU3DAction.)
	ForwardTraversal(SoNode)	Traverse a node that is not part of the current scenegraph. (Inherited from SoCallbackAction.)
	ForwardTraversal(SoPath)	Traverse a node that is not part of the current scenegraph. (Inherited from SoCallbackAction.)
	GetComplexity	Returns complexity information from the state. (Inherited from SoCallbackAction.)
	GetComplexityType	Returns complexity information from the state. (Inherited from SoCallbackAction.)
	GetContinueActionInBranchFlag	This function indicates if the action must stop in the current branch. (Inherited from SoAction.)
	GetCoordinate3	Returns the current coordinates from the state. (Inherited from SoCallbackAction.)
	GetCoordinate4	Returns the current coordinates from the state. (Inherited from SoCallbackAction.)
	GetCreaseAngle	Returns the current shape hints from the state. (Inherited from SoCallbackAction.)
	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. (Inherited from SoAction.)
	GetCurrentResponse	(Inherited from SoCallbackAction.)
	GetDecimationPercentage	Returns the current decimation percentage from the state. (Inherited from SoCallbackAction.)
	GetDecimationType	Returns the current decimation type from the state. (Inherited from SoCallbackAction.)
	GetDistribMode	Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only). (Inherited from SoAction.)
	GetDrawStyle	Returns the current drawing style information from the state. (Inherited from SoCallbackAction.)
	GetFaceType	Returns the current shape hints from the state. (Inherited from SoCallbackAction.)
	GetFocalDistance	Returns the current camera and viewing information from the state. (Inherited from SoCallbackAction.)
	GetFontName	Returns the current font information from the state. (Inherited from SoCallbackAction.)
	GetFontRenderStyle	Returns the current font information from the state. (Inherited from SoCallbackAction.)
	GetFontSize	Returns the current font information from the state. (Inherited from SoCallbackAction.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetLightAttenuation	Returns the current lighting model information from the state. (Inherited from SoCallbackAction.)
	GetLightModel	Returns the current lighting model information from the state. (Inherited from SoCallbackAction.)
	GetLinePattern	Returns the current drawing style information from the state. (Inherited from SoCallbackAction.)
	GetLinePatternScaleFactor	Returns the current drawing style information from the state. (Inherited from SoCallbackAction.)
	GetLineWidth	Returns the current drawing style information from the state. (Inherited from SoCallbackAction.)
	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. (Inherited from SoCallbackAction.)
	GetMaterialBinding	Returns the current material information from the state. (Inherited from SoCallbackAction.)
	GetModelMatrix	Returns the current modeling transformation from the state. (Inherited from SoCallbackAction.)
	GetNodeAppliedTo	Returns the node the action is being applied to. (Inherited from SoAction.)
	GetNormal	Returns the current normal information from the state. (Inherited from SoCallbackAction.)
	GetNormalBinding	Returns the current normal information from the state. (Inherited from SoCallbackAction.)
	GetNumCoordinates	Returns the current coordinates from the state. (Inherited from SoCallbackAction.)
	GetNumNormals	Returns the current normal information from the state. (Inherited from SoCallbackAction.)
	GetNumProfileCoordinates	Returns the current profiles and their coordinates from the state. (Inherited from SoCallbackAction.)
	GetNumTextureCoordinates	Returns texture information from the state. (Inherited from SoCallbackAction.)
	GetOriginalPathListAppliedTo	Returns the original path list the action is being applied to. (Inherited from SoAction.)
	GetPathAppliedTo	Returns the path the action is being applied to. (Inherited from SoAction.)
	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. (Inherited from SoAction.)
	GetPathListAppliedTo	Returns the path list the action is being applied to. (Inherited from SoAction.)
	GetPickStyle	Returns the current picking style. (Inherited from SoCallbackAction.)
	GetPipeId	Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration. (Inherited from SoAction.)
	GetPointSize	Returns the current drawing style information from the state. (Inherited from SoCallbackAction.)
	GetProfile	Returns the current profiles and their coordinates from the state. (Inherited from SoCallbackAction.)
	GetProfileCoordinate2	Returns the current profiles and their coordinates from the state. (Inherited from SoCallbackAction.)
	GetProfileCoordinate3	Returns the current profiles and their coordinates from the state. (Inherited from SoCallbackAction.)
	GetProjectionMatrix	Returns the current camera and viewing information from the state. (Inherited from SoCallbackAction.)
	GetSceneManager	Return the OIV.Inventor.SoSceneManager associated with this action. (Inherited from SoAction.)
	GetShapeType	Returns the current shape hints from the state. (Inherited from SoCallbackAction.)
	GetState	Gets the state from the action. (Inherited from SoAction.)
	GetSwitch	Returns the current switch value. (Inherited from SoCallbackAction.)
	GetTextureBlendColor	Returns texture information from the state. (Inherited from SoCallbackAction.)
	GetTextureCoordinate2	Returns texture information from the state. (Inherited from SoCallbackAction.)
	GetTextureCoordinate4	Returns texture information from the state. (Inherited from SoCallbackAction.)
	GetTextureCoordinateBinding	Returns texture information from the state. (Inherited from SoCallbackAction.)
	GetTextureFileName	Returns texture information from the state. (Inherited from SoCallbackAction.)
	GetTextureImage(SbVec2i32, Int32)	Returns texture information from the state. (Inherited from SoCallbackAction.)
	GetTextureImage(SbVec2s, Int32)	Obsolete. Returns texture information from the state. (Inherited from SoCallbackAction.)
	GetTextureMatrix	Returns the current texture mapping information from the state. (Inherited from SoCallbackAction.)
	GetTextureModel	Returns the current texture mapping information from the state. (Inherited from SoCallbackAction.)
	GetTextureTransformNode	Returns the current texture mapping information from the state. (Inherited from SoCallbackAction.)
	GetTextureWrapS	Returns the current texture mapping information from the state. (Inherited from SoCallbackAction.)
	GetTextureWrapT	Returns the current texture mapping information from the state. (Inherited from SoCallbackAction.)
	GetTransparencyType	Returns the current Transparency Type information from the state. (Inherited from SoCallbackAction.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnits	Returns the current units from the state. (Inherited from SoCallbackAction.)
	GetVertexOrdering	Returns the current shape hints from the state. (Inherited from SoCallbackAction.)
	GetViewingMatrix	Returns the current camera and viewing information from the state. (Inherited from SoCallbackAction.)
	GetViewVolume	Returns the current camera and viewing information from the state. (Inherited from SoCallbackAction.)
	GetWhatAppliedTo	Returns code indicating what action is being applied to. (Inherited from SoAction.)
	HasTerminated	Returns true if the traversal has reached a termination condition. (Inherited from SoAction.)
	InvalidateState	Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied. (Inherited from SoAction.)
	InvokePostCallbacks	(Inherited from SoCallbackAction.)
	InvokePreCallbacks	(Inherited from SoCallbackAction.)
	IsBeingApplied	Returns true if this action is currently being applied. (Inherited from SoAction.)
	IsCallbackAll	Returns whether the callback uses normal traversal (switches, etc.) or whether it traverses every single node. (Inherited from SoCallbackAction.)
	IsLastPathListAppliedTo	Returns true if the current list is the last one from the original. (Inherited from SoAction.)
	IsPolygonalText3Forced	Returns true if polygonal text3 is forced (see forcePolygonalText3). (Inherited from SoToU3DAction.)
	IsUsingAlternateRep	Returns true if current action is using alternate representations. (Inherited from SoAction.)
	OpenFile	Set the PDF output file. (Overrides SoToU3DActionOpenFile(String).)
	PostDelayedTraversal	Method called by SoMultiPassManager after delayed pass traversals. (Inherited from SoAction.)
	PreDelayedTraversal	Method called by SoMultiPassManager before delayed pass traversals. (Inherited from SoAction.)
	ResetContinueActionInBranchFlag	This function resets the continue action flag. (Inherited from SoAction.)
	SetCallbackAll	Sets whether the callback uses normal traversal (switches, etc.) or whether it traverses every single node. (Inherited from SoCallbackAction.)
	SetExportDraggers	Allow the export of draggers (default is true). (Inherited from SoToU3DAction.)
	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. (Inherited from SoAction.)
	SetSceneManager	Set the scene manager associated with this action (if any ). (Inherited from SoAction.)
	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. (Inherited from SoAction.)
	ShouldGeneratePrimitives	(Inherited from SoCallbackAction.)
	StopActionInBranch	This function stops the action in the current Scene Graph branch. (Inherited from SoAction.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Traverse	Does traversal of a graph rooted by a node. (Inherited from SoAction.)
	UseAlternateRep	Tell the action to use alternate representations during traversal when available. (Inherited from SoAction.)

Top

Events

	Name	Description
	PostTailTraversal	(Inherited from SoCallbackAction.)
	PreTailTraversal	(Inherited from SoCallbackAction.)

Top

Remarks

This 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

Copy

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.

Reference

OIV.HardCopy Namespace

OIV.HardCopy.SoToU3DAction