Writes a scene graph to a file. More...

#include <Inventor/actions/SoWriteAction.h>

Inheritance diagram for SoWriteAction:

Public Member Functions
	SoWriteAction ()
	Constructor.

	SoWriteAction (SoOutput *out)
	Constructor that takes an SoOutput to use for output.

virtual	~SoWriteAction ()
	Destructor.

SoOutput *	getOutput () const
	Returns pointer to SoOutput instance in action.

void	continueToApply (SoNode *node)
	Continues write action on a graph or path.

void	continueToApply (SoPath *path)

Public Member Functions inherited from SoAction
virtual	~SoAction ()
	Destructor.

virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.

bool	isOfType (SoType type) const
	Returns TRUE if this instance is of the type specified in `type` or is derived from that type.

virtual void	apply (SoNode *node)

virtual void	apply (SoPath *path)

virtual void	apply (const SoPathList &pathList, bool obeysRules=FALSE)
	Initiates an action on the graph defined either by a node, path, or list of paths.

virtual void	invalidateState ()
	Invalidates the current traversal state in the action, forcing it to be recreated when the action is next applied.

AppliedCode	getWhatAppliedTo () const
	Returns code indicating what action is being applied to.

SoNode *	getNodeAppliedTo () const
	These returns a pointer to the node, path, or path list the action is being applied to.

SoPath *	getPathAppliedTo () const

const SoPathList *	getPathListAppliedTo () const
	A single path list may be split into several, one for each different head node.

const SoPathList *	getOriginalPathListAppliedTo () const

bool	isLastPathListAppliedTo () const

PathCode	getPathCode (int &numIndices, const int *&indices)
	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.

void	traverse (SoNode *node)
	Does traversal of a graph rooted by a node.

bool	hasTerminated () const
	Returns TRUE if the traversal has reached a termination condition.

const SoPath *	getCurPath ()
	Returns a pointer to the path accumulated during traversal, i.e., the chain of nodes from the root of the traversed graph to the current node being traversed.

SoState *	getState () const
	Get the state from the action.

PathCode	getCurPathCode () const
	These methods maintain the current path accumulated so far during traversal.

void	pushCurPath (int childIndex)

void	popCurPath (PathCode prevPathCode)

virtual SoNode *	getCurPathTail ()
	This is virtual, so that SoCallbackAction can use current node.

void	usePathCode (int &numIndices, const int *&indices)
	called by inline getPathCode:

void	pushCurPath ()
	Optimized versions of push/pop when we know path codes won't change:

void	popPushCurPath (int childIndex)

void	popCurPath ()

const SoLightweightPath &	getCurrentLightweightPath () const
	Returns the current "light" path.

void	setCurrentLightweightPath (const SoLightweightPath &path)
	Sets the current "light" path.

Static Public Member Functions
static void	initClass ()

Static Public Member Functions inherited from SoAction
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

static void	nullAction (SoAction , SoNode )
	Null action method that can be stored in lookup table when desired.

static void	initClass ()

static void	initClasses ()
	Initialize ALL Inventor action classes.

Protected Member Functions
virtual void	beginTraversal (SoNode *node)
	Initiates action on graph.

virtual bool	shouldCompactPathLists () const
	Override method to return FALSE, since this action applies itself to each path separately, so it doesn't need the extra overhead of compacting the list.

Protected Member Functions inherited from SoAction
	SoAction ()
	Constructor.

virtual const SoEnabledElementsList &	getEnabledElements () const
	Returns the list of enabled elements for a given action subclass.

virtual void	beginTraversal (SoNode *node)
	Begins traversal of an action at the given node.

void	setTerminated (bool flag)
	Allows subclass instance to indicate that traversal has reached a termination condition.

virtual bool	shouldCompactPathLists () const
	This method is used when applying an action to an SoPathList.

Additional Inherited Members
Public Types inherited from SoAction
enum	AppliedCode { NODE , PATH , PATH_LIST }
	This enum is used to determine what the action is being applied to. More...

enum	PathCode { NO_PATH , IN_PATH , BELOW_PATH , OFF_PATH }
	This enum may be used during traversal of nodes to indicate where the node is with respect to the path being traversed. More...

Protected Attributes inherited from SoAction
SoState *	state
	Traversal state.

SoActionMethodList *	traversalMethods
	The list of what to do when.

Static Protected Attributes inherited from SoAction
static SoEnabledElementsList *	enabledElements
	Holds list of enabled elements for the SoAction class.

static SoActionMethodList *	methods
	... and the methods

Detailed Description

This class is used for writing scene graphs to files. It contains an SoOutput instance that by default writes to the standard output. Methods on the SoOutput can be called to specify what file or memory buffer to write to.

See Also

: SoOutput

Definition at line 80 of file SoWriteAction.h.

Constructor & Destructor Documentation

◆ SoWriteAction() [1/2]

SoWriteAction::SoWriteAction ( )

◆ SoWriteAction() [2/2]

SoWriteAction::SoWriteAction ( SoOutput * out )

◆ ~SoWriteAction()

virtual SoWriteAction::~SoWriteAction ( )

virtual

Member Function Documentation

◆ beginTraversal()

virtual void SoWriteAction::beginTraversal ( SoNode * node )

protectedvirtual

Reimplemented from SoAction.

◆ continueToApply() [1/2]

void SoWriteAction::continueToApply ( SoNode * node )

◆ continueToApply() [2/2]

void SoWriteAction::continueToApply ( SoPath * path )

◆ getOutput()

SoOutput * SoWriteAction::getOutput ( ) const

inline

Definition at line 96 of file SoWriteAction.h.

◆ initClass()

static void SoWriteAction::initClass ( )

static

◆ shouldCompactPathLists()

virtual bool SoWriteAction::shouldCompactPathLists ( ) const