Click or drag to resize
SoToU3DAction Class

Export a scene graph to a U3D file.

Inheritance Hierarchy

Namespace: OIV.HardCopy
Assembly: OIV.HardCopy (in OIV.HardCopy.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoToU3DAction : SoCallbackAction

The SoToU3DAction type exposes the following members.

Constructors
  NameDescription
Public methodSoToU3DAction
Initializes a new instance of the SoToU3DAction class
Top
Methods
  NameDescription
Public methodAddLineSegmentCallback

Routine to add callbacks for generated primitives (line segments) for all shapes of the given type.

(Inherited from SoCallbackAction.)
Public methodAddPointCallback

Routine to add callbacks for generated primitives (points) for all shapes of the given type.

(Inherited from SoCallbackAction.)
Public methodAddPostCallback

Adds a callback function to call when a node of the given type is encountered during traversal.

(Inherited from SoCallbackAction.)
Public methodAddPreCallback

Adds a callback function to call when a node of the given type is encountered during traversal.

(Inherited from SoCallbackAction.)
Public methodAddTriangleCallback

Routine to add callbacks for generated primitives (triangles) for all shapes of the given type.

(Inherited from SoCallbackAction.)
Public methodApply(SoNode)

Initiates an action on the graph specified by a node.

(Overrides SoActionApply(SoNode).)
Public methodApply(SoPath)

Initiates an action on the graph specified by a path.

(Overrides SoActionApply(SoPath).)
Public methodApply(SoPathList)
Calls Apply(pathList, false).
Public methodApply(SoPathList, Boolean)

Initiates an action on the graph specified by list of paths.

(Overrides SoActionApply(SoPathList, Boolean).)
Public methodAreDraggersExported

Returns true if draggers are exported.

Public methodClearApplyResult

When applied, an action may reference nodes or create objects (e.g.

(Inherited from SoAction.)
Public methodCloseFile

Finalize export to the U3D output file.

Public methodStatic memberEnableElement
Public methodEnableElements

(Overrides SoCallbackActionEnableElements.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodForcePolygonalText3

Forces OIV.Inventor.Nodes.SoText2 nodes to be exported using OIV.Inventor.Nodes.SoText3 (default is true).

Public methodForwardTraversal(SoNode)

Traverse a node that is not part of the current scenegraph.

(Inherited from SoCallbackAction.)
Public methodForwardTraversal(SoPath)

Traverse a node that is not part of the current scenegraph.

(Inherited from SoCallbackAction.)
Public methodGetComplexity

Returns complexity information from the state.

(Inherited from SoCallbackAction.)
Public methodGetComplexityType

Returns complexity information from the state.

(Inherited from SoCallbackAction.)
Public methodGetContinueActionInBranchFlag

This function indicates if the action must stop in the current branch.

(Inherited from SoAction.)
Public methodGetCoordinate3

Returns the current coordinates from the state.

(Inherited from SoCallbackAction.)
Public methodGetCoordinate4

Returns the current coordinates from the state.

(Inherited from SoCallbackAction.)
Public methodGetCreaseAngle

Returns the current shape hints from the state.

(Inherited from SoCallbackAction.)
Public methodGetCurPath

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.)
Public methodGetCurrentResponse
(Inherited from SoCallbackAction.)
Public methodGetDecimationPercentage

Returns the current decimation percentage from the state.

(Inherited from SoCallbackAction.)
Public methodGetDecimationType

Returns the current decimation type from the state.

(Inherited from SoCallbackAction.)
Public methodGetDistribMode

Returns the distribution mode of this action across a cluster (ScaleViz-Cluster only).

(Inherited from SoAction.)
Public methodGetDrawStyle

Returns the current drawing style information from the state.

(Inherited from SoCallbackAction.)
Public methodGetFaceType

Returns the current shape hints from the state.

(Inherited from SoCallbackAction.)
Public methodGetFocalDistance

Returns the current camera and viewing information from the state.

(Inherited from SoCallbackAction.)
Public methodGetFontName

Returns the current font information from the state.

(Inherited from SoCallbackAction.)
Public methodGetFontRenderStyle

Returns the current font information from the state.

(Inherited from SoCallbackAction.)
Public methodGetFontSize

Returns the current font information from the state.

(Inherited from SoCallbackAction.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetLightAttenuation

Returns the current lighting model information from the state.

(Inherited from SoCallbackAction.)
Public methodGetLightModel

Returns the current lighting model information from the state.

(Inherited from SoCallbackAction.)
Public methodGetLinePattern

Returns the current drawing style information from the state.

(Inherited from SoCallbackAction.)
Public methodGetLinePatternScaleFactor

Returns the current drawing style information from the state.

(Inherited from SoCallbackAction.)
Public methodGetLineWidth

Returns the current drawing style information from the state.

(Inherited from SoCallbackAction.)
Public methodGetMaterial(SbColor, SbColor, SbColor, SbColor, Single, Single)
Calls GetMaterial(ambient, diffuse, specular, emission, shininess, transparency, System.Int32(0)).
(Inherited from SoCallbackAction.)
Public methodGetMaterial(SbColor, SbColor, SbColor, SbColor, Single, Single, Int32)

Returns the current material information from the state.

(Inherited from SoCallbackAction.)
Public methodGetMaterialBinding

Returns the current material information from the state.

(Inherited from SoCallbackAction.)
Public methodGetModelMatrix

Returns the current modeling transformation from the state.

(Inherited from SoCallbackAction.)
Public methodGetNodeAppliedTo

Returns the node the action is being applied to.

(Inherited from SoAction.)
Public methodGetNormal

Returns the current normal information from the state.

(Inherited from SoCallbackAction.)
Public methodGetNormalBinding

Returns the current normal information from the state.

(Inherited from SoCallbackAction.)
Public methodGetNumCoordinates

Returns the current coordinates from the state.

(Inherited from SoCallbackAction.)
Public methodGetNumNormals

Returns the current normal information from the state.

(Inherited from SoCallbackAction.)
Public methodGetNumProfileCoordinates

Returns the current profiles and their coordinates from the state.

(Inherited from SoCallbackAction.)
Public methodGetNumTextureCoordinates

Returns texture information from the state.

(Inherited from SoCallbackAction.)
Public methodGetOriginalPathListAppliedTo

Returns the original path list the action is being applied to.

(Inherited from SoAction.)
Public methodGetPathAppliedTo

Returns the path the action is being applied to.

(Inherited from SoAction.)
Public methodGetPathCode

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.)
Public methodGetPathListAppliedTo

Returns the path list the action is being applied to.

(Inherited from SoAction.)
Public methodGetPickStyle

Returns the current picking style.

(Inherited from SoCallbackAction.)
Public methodGetPipeId

Gets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

(Inherited from SoAction.)
Public methodGetPointSize

Returns the current drawing style information from the state.

(Inherited from SoCallbackAction.)
Public methodGetProfile

Returns the current profiles and their coordinates from the state.

(Inherited from SoCallbackAction.)
Public methodGetProfileCoordinate2

Returns the current profiles and their coordinates from the state.

(Inherited from SoCallbackAction.)
Public methodGetProfileCoordinate3

Returns the current profiles and their coordinates from the state.

(Inherited from SoCallbackAction.)
Public methodGetProjectionMatrix

Returns the current camera and viewing information from the state.

(Inherited from SoCallbackAction.)
Public methodGetSceneManager

Return the OIV.Inventor.SoSceneManager associated with this action.

(Inherited from SoAction.)
Public methodGetShapeType

Returns the current shape hints from the state.

(Inherited from SoCallbackAction.)
Public methodGetState

Gets the state from the action.

(Inherited from SoAction.)
Public methodGetSwitch

Returns the current switch value.

(Inherited from SoCallbackAction.)
Public methodGetTextureBlendColor

Returns texture information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureCoordinate2

Returns texture information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureCoordinate4

Returns texture information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureCoordinateBinding

Returns texture information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureFileName

Returns texture information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureImage(SbVec2i32, Int32)

Returns texture information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureImage(SbVec2s, Int32) Obsolete.

Returns texture information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureMatrix

Returns the current texture mapping information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureModel

Returns the current texture mapping information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureTransformNode

Returns the current texture mapping information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureWrapS

Returns the current texture mapping information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTextureWrapT

Returns the current texture mapping information from the state.

(Inherited from SoCallbackAction.)
Public methodGetTransparencyType

Returns the current Transparency Type information from the state.

(Inherited from SoCallbackAction.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUnits

Returns the current units from the state.

(Inherited from SoCallbackAction.)
Public methodGetVertexOrdering

Returns the current shape hints from the state.

(Inherited from SoCallbackAction.)
Public methodGetViewingMatrix

Returns the current camera and viewing information from the state.

(Inherited from SoCallbackAction.)
Public methodGetViewVolume

Returns the current camera and viewing information from the state.

(Inherited from SoCallbackAction.)
Public methodGetWhatAppliedTo

Returns code indicating what action is being applied to.

(Inherited from SoAction.)
Public methodHasTerminated

Returns true if the traversal has reached a termination condition.

(Inherited from SoAction.)
Public methodInvalidateState

Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied.

(Inherited from SoAction.)
Public methodInvokePostCallbacks
(Inherited from SoCallbackAction.)
Public methodInvokePreCallbacks
(Inherited from SoCallbackAction.)
Public methodIsBeingApplied

Returns true if this action is currently being applied.

(Inherited from SoAction.)
Public methodIsCallbackAll

Returns whether the callback uses normal traversal (switches, etc.) or whether it traverses every single node.

(Inherited from SoCallbackAction.)
Public methodIsLastPathListAppliedTo

Returns true if the current list is the last one from the original.

(Inherited from SoAction.)
Public methodIsPolygonalText3Forced

Returns true if polygonal text3 is forced (see forcePolygonalText3).

Public methodIsUsingAlternateRep

Returns true if current action is using alternate representations.

(Inherited from SoAction.)
Public methodOpenFile

Set the U3D output file.

Public methodPostDelayedTraversal

Method called by SoMultiPassManager after delayed pass traversals.

(Inherited from SoAction.)
Public methodPreDelayedTraversal

Method called by SoMultiPassManager before delayed pass traversals.

(Inherited from SoAction.)
Public methodResetContinueActionInBranchFlag

This function resets the continue action flag.

(Inherited from SoAction.)
Public methodSetCallbackAll

Sets whether the callback uses normal traversal (switches, etc.) or whether it traverses every single node.

(Inherited from SoCallbackAction.)
Public methodSetExportDraggers

Allow the export of draggers (default is true).

Public methodSetPipeId

Sets pipe identifier in the range [1..N] associated to this render action while running a ScaleViz Multipipe configuration.

(Inherited from SoAction.)
Public methodSetSceneManager

Set the scene manager associated with this action (if any ).

(Inherited from SoAction.)
Public methodSetUpState

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.)
Public methodShouldGeneratePrimitives
(Inherited from SoCallbackAction.)
Public methodStopActionInBranch

This function stops the action in the current Scene Graph branch.

(Inherited from SoAction.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTraverse

Does traversal of a graph rooted by a node.

(Inherited from SoAction.)
Public methodUseAlternateRep

Tell the action to use alternate representations during traversal when available.

(Inherited from SoAction.)
Top
Events
  NameDescription
Public eventPostTailTraversal
(Inherited from SoCallbackAction.)
Public eventPreTailTraversal
(Inherited from SoCallbackAction.)
Top
Remarks

This class can export an Open Inventor scenegraph to a U3D file. U3D files can be used to import a 3D scene into a PDF file. For a simple PDF export, see OIV.HardCopy.SoToPDFAction.

U3D is a much simpler format than the Open Inventor scene graph and limits what can be exported.

Limitations of U3D:

  • Cameras

  • Lights

    • Lights affect the whole scenegraph no matter where they are placed in the scenegraph.

    • Per-vertex lighting is precomputed with default lights.

    • Two-sided lighting is not supported. Incorrect normals will result in black triangles. However note that the end user can enable two sided rendering in the Acrobat Reader preferences dialog under the "3D & Multimedia" tab.

  • Lines

    • Line width is not supported.

    • Per-vertex coloring and lighting are not supported on lines.

    • Precision issue on line vertices. Point locations may drasticaly diverge from orginal. Since this problem increases with the number of vertices per shape, try to split lines into smaller shapes.

  • MeshVizXLM

    • Enhanced coloring (MoMaterial) is not supported.

    • Fading threshold (MoDrawStyle) is not supported.

    • Polygon offset is not supported, so rendering cells with both faces and edges may result in depth buffering problems in the Adobe viewer.

  • Miscellaneous

    • FXViz representations are not supported.

    • Engines are ignored.

    • Dragger shapes are not exported.

  • Points

    • Coloring is not supported on points.

  • Rendering

  • Text

    • Text2 and textured Text3 are converted into polygonal Text3.

  • Textures

    • Only MODULATE and REPLACE texture models are supported.

    • Only REPEAT and CLAMP texture wraps are supported.

    • Multitexturing is not supported.

  • Transparency

    • Transparency is exported, but Adobe Reader's transparency algorithm is limited. Solid objects, MeshVizXLM mesh skin for example, can be handled correctly by Open Inventor's SORTED_PIXEL algorithm, but are not (in general) handled correctly by Adobe Reader (as of version 10.1 anyway).

  • VolumeViz

    • VolumeViz representations are not supported, except orthoslice, obliqueslice and volumeskin.

    • VolumeViz slices are exported with their current LOD (NB: LOD is minimal if the node has never been rendered).

    • LDM volumes with overlap of zero will not export correctly (gaps between tiles will be visible.

    • ROIs are ignored.

    • Lighting on VolumeViz slices is not supported.

    • VolumeViz slices are exported as simple RGBA textures (no colormap), which impacts visual quality (as if useRGBA field set)

Tips

  • Node names

    • Node names are exported for OIV.Inventor.Nodes.SoSeparator and OIV.Inventor.Nodes.SoShape, as well as all derived classes. These names will appear in the "Model Tree" in Acrobat Reader. The end user can set visibility, render mode, etc for each object. You can also use these names in JavaScript functions that manipulate the model in the PDF file.

    • Separator nodes with no assigned name will appear in the tree as "Group-XXX" and Shape nodes with no assigned name will appear in the tree as "Model-XXX", where "XXX" is the address of the node (just to make the name unique).

    • Names in the U3D file must be unique. Nodes with duplicate names will have a numeric value automatically appended to their name.

  • Lights: Lights in the scene graph will be exported. However note that the viewer's headlight will be exported as a directional light with a fixed position (it will not automatically rotate with the camera). If Acrobat Reader finds lights in the U3D file it will use those lights. So it may be better to export without lights and also to turn off the viewer's headlight before exporting to U3D. Note that one of the lighting options in Acrobat Reader is a headlight (that rotates with the camera).

  • Camera: If the action finds a camera in the scene graph, that camera will define the default view for the model in the PDF file. Therefore if you apply the action to a Separator above the viewer's camera, the exported model will be displayed with the current on-screen view.

  • Background color: You can export a background color using an OIV.Inventor.Nodes.SoGradientBackground node. The exported color will be the average of the color0 and color1 fields. However you can also change the background color using Adobe Acrobat Pro after inserting the U3D file in a PDF.

  • Two sided rendering: If the back faces of your geometry are black when displayed in Acrobat Reader, you may want to advise your users to enable the two sided rendering option in Reader's Preferences dialog under the "3D & Multimedia" tab.

  • Tools:

    • You can use the commercial tool Adobe Acrobat Pro to create and modify PDFs with embedded U3D content. Adobe calls this content "3D annotations".

    • You can also use open source tools like pdflatex, with the movie15 package, to create a PDF file with embedded 3D from a LaTeX source file.

Use case

SoSeparator root = new SoSeparator();
...
SoToU3DAction u3dAction = new SoToU3DAction();
bool result = u3dAction.OpenFile( "output.u3d" );
if ( !result )
{
  // Report error
}
u3dAction.Apply( root );
result = u3dAction.CloseFile();
if ( !result )
{
  // Report error
}

Warning

  • On some platforms, some applications may encounter problems loading, displaying an error message like: "IFXOSFileIterator.ProcessDir: error opening /usr/local/u3d/lib/Plugins/ No such file or directory". In this case, declare the environment variable U3D_LIBDIR (UNIX only) and set it with the path to the Open Inventor libraries ($OIVHOME/lib).

  • It is now possible to specify a directory name which will contain the U3D plug-ins by setting the environment variable U3D_PLUGINS_DIRNAME for instance: "U3DPlugins". Important: This is not a path to the directory. Moreover this directory must remain in the same folder as fei_ifx_core.so/dll.

  • By default this action always uses the alternate representation of an OIV.Inventor.Nodes.SoNode derived class (if one exists).

  • The U3D_LIBDIR path is limited to 103 characters, path plus filename. If this length is exceeded, an error message is outputed and U3D library is not loaded.

See Also