SoToVRMLAction Class Reference

The SoToVRMLAction class builds a new scene graph using only VRML 1.0 nodes. More...

#include <Inventor/actions/SoToVRMLAction.h>

Inheritance diagram for SoToVRMLAction:

Public Member Functions
	SoToVRMLAction (void)
virtual	~SoToVRMLAction (void)
virtual void	apply (const SoPathList &pathlist, SbBool obeysrules=FALSE)
virtual void	apply (SoNode *node)
virtual void	apply (SoPath *path)
SbBool	areSoFileExpanded (void) const
SbBool	areTexCoordWritten (void) const
SbBool	areTexture2NodeExpanded (void) const
SbBool	areUnknownNodeKept (void) const
void	conditionalConversion (SbBool flag)
void	convertInlineNodes (SbBool flag)
SbBool	doConditionalConversion (void) const
SbBool	doConvertInlineNodes (void) const
void	expandSoFile (SbBool flag)
void	expandTexture2Node (SbBool flag)
virtual SoType	getTypeId (void) const
SbString	getUrlName (void) const
SoNode *	getVRMLSceneGraph (void) const
SbBool	isVerbose (void) const
void	keepUnknownNodes (SbBool flag)
void	setUrlName (const SbString name)
void	setVerbosity (SbBool flag)
void	writeTexCoords (SbBool flag)
Public Member Functions inherited from SoAction
virtual	~SoAction (void)
void	apply (SoAction *beingApplied)
const SoPath *	getCurPath (void)
PathCode	getCurPathCode (void) const
virtual SoNode *	getCurPathTail (void)
SoNode *	getNodeAppliedTo (void) const
const SoPathList *	getOriginalPathListAppliedTo (void) const
SoPath *	getPathAppliedTo (void) const
PathCode	getPathCode (int &numindices, const int *&indices)
const SoPathList *	getPathListAppliedTo (void) const
SoState *	getState (void) const
AppliedCode	getWhatAppliedTo (void) const
SbBool	hasTerminated (void) const
virtual void	invalidateState (void)
SbBool	isLastPathListAppliedTo (void) const
virtual SbBool	isOfType (SoType type) const
void	popCurPath (const PathCode prevpathcode)
void	popCurPath (void)
void	popPushCurPath (const int childindex, SoNode *node=NULL)
void	pushCurPath (const int childindex, SoNode *node=NULL)
void	pushCurPath (void)
void	switchToNodeTraversal (SoNode *node)
void	switchToPathTraversal (SoPath *path)
void	traverse (SoNode *const node)
void	usePathCode (int &numindices, const int *&indices)

Static Public Member Functions
static void	addMethod (const SoType type, SoActionMethod method)
static void	enableElement (const SoType type, const int stackindex)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoAction
static SoType	getClassTypeId (void)
static void	initClass (void)
static void	initClasses (void)
static void	nullAction (SoAction *action, SoNode *node)

Protected Member Functions
virtual void	beginTraversal (SoNode *node)
virtual const SoEnabledElementsList &	getEnabledElements (void) const
Protected Member Functions inherited from SoAction
	SoAction (void)
virtual void	endTraversal (SoNode *node)
void	setTerminated (const SbBool flag)
virtual SbBool	shouldCompactPathList (void) const

Static Protected Member Functions
static SoActionMethodList *	getClassActionMethods (void)
static SoEnabledElementsList *	getClassEnabledElements (void)
Static Protected Member Functions inherited from SoAction
static SoActionMethodList *	getClassActionMethods (void)
static SoEnabledElementsList *	getClassEnabledElements (void)

Additional Inherited Members
Public Types inherited from SoAction
enum	AppliedCode { NODE = 0 , PATH = 1 , PATH_LIST = 2 }
enum	PathCode { NO_PATH = 0 , IN_PATH = 1 , BELOW_PATH = 2 , OFF_PATH = 3 }
Protected Attributes inherited from SoAction
SoState *	state
SoActionMethodList *	traversalMethods

Detailed Description

The SoToVRMLAction class builds a new scene graph using only VRML 1.0 nodes.

This action is used for converting a scene graph of VRML2/VRML97 nodes to a new scene graph using only VRML1 compatible nodes.

A current limitation of this action is that nodes specific for Inventor / Coin (i.e. neither VRML1 nor VRML97 compatible nodes) are not tried to convert, they are simply ignored.

See also

SoToVRML2Action

Since

Coin 2.0

TGS Inventor 2.5

Constructor & Destructor Documentation

SoToVRMLAction()

SoToVRMLAction::SoToVRMLAction

(

void

)

Constructor.

~SoToVRMLAction()

SoToVRMLAction::~SoToVRMLAction ( void )

virtual

The destructor.

Member Function Documentation

addMethod()

void SoToVRMLAction::addMethod ( const SoType type, SoActionMethod method )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

apply() [1/3]

void SoToVRMLAction::apply ( const SoPathList & pathlist, SbBool obeysrules = FALSE )

virtual

Applies action to the graphs defined by pathlist. If obeysrules is set to TRUE, pathlist must obey the following four conditions (which is the case for path lists returned from search actions for non-group nodes and path lists returned from picking actions):

All paths must start at the same head node. All paths must be sorted in traversal order. The paths must be unique. No path can continue through the end point of another path.

See also

SoAction::apply(SoPath * path)

Reimplemented from SoAction.

Reimplemented in SoToVRML2Action.

apply() [2/3]

void SoToVRMLAction::apply ( SoNode * root )

virtual

Applies the action to the scene graph rooted at root.

Note that you should not apply an action to a node with a zero reference count. The behavior in that case is undefined.

Reimplemented from SoAction.

Reimplemented in SoToVRML2Action.

apply() [3/3]

void SoToVRMLAction::apply ( SoPath * path )

virtual

Applies the action to the parts of the graph defined by path.

Note that an SoPath will also contain all nodes that may influence e.g. geometry nodes in the path. So for instance applying an SoGLRenderAction on an SoPath will render that path as expected in the view, where geometry will get its materials, textures, and other appearance settings correctly.

If the path ends in an SoGroup node, the action will also traverse the tail node's children.

Reimplemented from SoAction.

Reimplemented in SoToVRML2Action.

areSoFileExpanded()

SbBool SoToVRMLAction::areSoFileExpanded

(

void

)

const

Returns whether SoFile nodes are expanded (i.e. their contents is copied) in the new scene graph or not.

areTexCoordWritten()

SbBool SoToVRMLAction::areTexCoordWritten

(

void

)

const

Returns whether texture coordinates are written to the new scene graph or not.

areTexture2NodeExpanded()

SbBool SoToVRMLAction::areTexture2NodeExpanded

(

void

)

const

Returns whether texture files are expanded (i.e. their contents is copied) in the new scene graph or not.

areUnknownNodeKept()

SbBool SoToVRMLAction::areUnknownNodeKept

(

void

)

const

Returns whether unknown nodes are preserved in the new scene graph or not.

beginTraversal()

void SoToVRMLAction::beginTraversal ( SoNode * node )

protectedvirtual

This virtual method is called from SoAction::apply(), and is the entry point for the actual scene graph 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 scene graph traversal.

Reimplemented from SoAction.

Reimplemented in SoToVRML2Action.

conditionalConversion()

void SoToVRMLAction::conditionalConversion

(

SbBool

flag

)

Sets whether inline nodes are conditionally converted to VRML in the new scene graph or not.

convertInlineNodes()

void SoToVRMLAction::convertInlineNodes

(

SbBool

flag

)

Sets whether inline nodes are converted to VRML in the new scene graph or not.

doConditionalConversion()

SbBool SoToVRMLAction::doConditionalConversion

(

void

)

const

Returns whether inline nodes are conditionally converted to VRML in the new scene graph or not.

doConvertInlineNodes()

SbBool SoToVRMLAction::doConvertInlineNodes

(

void

)

const

Returns whether inline nodes are converted to VRML in the new scene graph or not.

enableElement()

void SoToVRMLAction::enableElement ( const SoType type, const int stackindex )

static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

expandSoFile()

void SoToVRMLAction::expandSoFile

(

SbBool

flag

)

Sets whether SoFile nodes are expanded (i.e. their contents is copied) in the new scene graph or not.

expandTexture2Node()

void SoToVRMLAction::expandTexture2Node

(

SbBool

flag

)

Sets whether texture files are expanded (i.e. their contents is copied) in the new scene graph or not.

getClassActionMethods()

SoActionMethodList * SoToVRMLAction::getClassActionMethods ( void )

staticprotected

Returns list of action methods for this class. The enabledElements and methods variables are protected in the original OIV API. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

getClassEnabledElements()

SoEnabledElementsList * SoToVRMLAction::getClassEnabledElements ( void )

staticprotected

Returns list of enabled elements for this class. The enabledElements and methods variables are protected in the original OIV API. This is not such a good idea, since exposed static class member variables is a major grievance with regard to Win32 DLLs. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

getClassTypeId()

SoType SoToVRMLAction::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

getEnabledElements()

const SoEnabledElementsList & SoToVRMLAction::getEnabledElements ( void ) const

protectedvirtual

Returns list of enabled elements.

Reimplemented from SoAction.

Reimplemented in SoToVRML2Action.

getTypeId()

SoType SoToVRMLAction::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoAction. This is used for runtime type checking and "downward" casting.

Implements SoAction.

Reimplemented in SoToVRML2Action.

getUrlName()

SbString SoToVRMLAction::getUrlName

(

void

)

const

Returns the URL (directory) where VRML inline nodes are written to.

getVRMLSceneGraph()

SoNode * SoToVRMLAction::getVRMLSceneGraph

(

void

)

const

Returns the VRML scene graph.

initClass()

void SoToVRMLAction::initClass ( void )

static

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

isVerbose()

SbBool SoToVRMLAction::isVerbose

(

void

)

const

Returns whether additional information should be written to output during the conversion process.

keepUnknownNodes()

void SoToVRMLAction::keepUnknownNodes

(

SbBool

flag

)

Sets whether unknown nodes are preserved in the new scene graph or not.

setUrlName()

void SoToVRMLAction::setUrlName

(

const SbString

name

)

Sets the URL (directory) where VRML inline nodes are written to.

setVerbosity()

void SoToVRMLAction::setVerbosity

(

SbBool

flag

)

Sets whether additional information should be written to output during the conversion process.

writeTexCoords()

void SoToVRMLAction::writeTexCoords

(

SbBool

flag

)

Sets whether texture coordinates are written to the new scene graph or not.

---

The documentation for this class was generated from the following files:

• SoToVRMLAction.h
• SoToVRMLAction.cpp