Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SoWriteAction Class Reference

The SoWriteAction class writes a scene graph to file. More...

#include <Inventor/actions/SoWriteAction.h>

Inheritance diagram for SoWriteAction::

SoAction List of all members.

Public Methods

 SoWriteAction (void)
 SoWriteAction (SoOutput *out)
virtual ~SoWriteAction ()
SoOutputgetOutput (void) const
void continueToApply (SoNode *node)
void continueToApply (SoPath *path)

Static Public Methods

void initClass (void)

Protected Methods

virtual void beginTraversal (SoNode *node)
virtual SbBool shouldCompactPathLists (void) const

Detailed Description

The SoWriteAction class writes a scene graph to file.

When applied to a scene, this action writes its contents to the stream contained within an SoOutput instance. This can be a file, a memory buffer or a system filehandle like stdout, for instance.

All information considered part of the scene graph should be written out, including not only nodes, but also the nodes' field values, global fields (at least those with connections inside the scene the action is applied to), engines in the scene, paths, etc.

The scene is written in the Open Inventor file format. Files in this format can be parsed into their scene graph structures by using the SoDB::readAll() method (SoDB also contains a few other import methods you can use).

See also:
SoOutput


Constructor & Destructor Documentation

SoWriteAction::SoWriteAction void
 

Default constructor. Output will be written to stdout in ASCII format.

SoWriteAction::SoWriteAction SoOutput * out
 

Constructor. Output will be written via the out object.

SoWriteAction::~SoWriteAction void [virtual]
 

Destructor.


Member Function Documentation

void SoWriteAction::initClass void [static]
 

Initializes the run-time type system for this class, and sets up the enabled elements and action method list.

Reimplemented from SoAction.

SoOutput * SoWriteAction::getOutput void const
 

Returns a pointer to the SoOutput object we're using when writing the scene graph.

void SoWriteAction::continueToApply SoNode * node
 

Applies the write method to the subgraph starting at node with the current SoOutput instance, without resetting any of the internal state of the action instance.

This should normally be for internal use only.

void SoWriteAction::continueToApply SoPath * path
 

Applies the write method to path with the current SoOutput instance, without resetting any of the internal state of the action instance.

This should normally be for internal use only.

void SoWriteAction::beginTraversal SoNode * node [protected, virtual]
 

This virtual method is called from SoAction::apply(), and is the entry point for the actual scenegraph traversal.

It can be overridden to initialize the action at traversal start, for specific initializations in the action subclasses inheriting SoAction.

Default method just calls traverse(), which any overridden implementation of the method must do too (or call SoAction::beginTraversal()) to trigger the scenegraph traversal.

Reimplemented from SoAction.

SbBool SoWriteAction::shouldCompactPathLists void const [protected, virtual]
 

For internal use only.


The documentation for this class was generated from the following files:
Generated at Tue Mar 5 03:31:33 2002 for Coin by doxygen1.2.9 written by Dimitri van Heesch, © 1997-2001