Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
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:
SoAction SoToVRML2Action

Public Member Functions

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

Static Public Member Functions

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

Protected Member Functions

virtual const SoEnabledElementsListgetEnabledElements (void) const
 
virtual void beginTraversal (SoNode *node)
 
- 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 SoEnabledElementsListgetClassEnabledElements (void)
 
static SoActionMethodListgetClassActionMethods (void)
 
- Static Protected Member Functions inherited from SoAction
static SoEnabledElementsListgetClassEnabledElements (void)
 
static SoActionMethodListgetClassActionMethods (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
SoStatestate
 
SoActionMethodListtraversalMethods
 

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

◆ getTypeId()

SoType SoToVRMLAction::getTypeId ( void  ) const
virtual

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

Usage example:

void bar(SoAction * action)
{
if (action->getTypeId() == SoGLRenderAction::getClassTypeId()) {
// safe downward cast, know the type
SoGLRenderAction * glrender = (SoGLRenderAction *)action;
}
return; // ignore if not render action
}

For application programmers wanting to extend the library with new actions: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the predefined macros available through Inventor/nodes/SoSubAction.h: SO_ACTION_SOURCE, SO_ACTION_INIT_CLASS and SO_ACTION_CONSTRUCTOR.

For more information on writing Coin extensions, see the SoAction class documentation.

Returns the actual type id of an object derived from a class inheriting SoAction. Needs to be overridden in all subclasses.

Implements SoAction.

Reimplemented in SoToVRML2Action.

◆ 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.

◆ 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.

◆ getEnabledElements()

const SoEnabledElementsList & SoToVRMLAction::getEnabledElements ( void  ) const
protectedvirtual

Returns a list of the elements used by action instances of this class upon traversal operations.

Reimplemented from SoAction.

Reimplemented in SoToVRML2Action.

◆ apply() [1/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() [2/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.

◆ apply() [3/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.

◆ 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.


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