SoToVRMLAction(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ SoToVRMLAction ✨

okay so this is the SoToVRMLAction(3) manual page from the Library Functions Manual, and bestie, it's giving very specific conversion energy 💅. It's a whole class that takes your scene graph and rebuilds it out of nothing but VRML 1.0 nodes. No cap.

🎀 NAME

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

🦋 SYNOPSIS

#include <Inventor/actions/SoToVRMLAction.h>

Inherits SoAction.

Inherited by SoToVRML2Action.

💖 Public Member Functions

  • virtual SoType getTypeId (void) const
  • SoToVRMLAction (void)
  • virtual ~SoToVRMLAction ()
  • virtual void apply (SoNode *node)
  • virtual void apply (SoPath *path)
  • virtual void apply (const SoPathList &pathlist, SbBool obeysrules=0)
  • SoNode * getVRMLSceneGraph (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

like, the freebies you get handed down from the parent class:

  • virtual ~SoAction ()
  • virtual SbBool isOfType (SoType type) const
  • void apply (SoAction *beingApplied)
  • virtual void invalidateState (void)
  • AppliedCode getWhatAppliedTo (void) const
  • SoNode * getNodeAppliedTo (void) const
  • SoPath * getPathAppliedTo (void) const
  • const SoPathList * getPathListAppliedTo (void) const
  • const SoPathList * getOriginalPathListAppliedTo (void) const
  • SbBool isLastPathListAppliedTo (void) const
  • PathCode getPathCode (int &numindices, const int *&indices)
  • void traverse (SoNode *const node)
  • SbBool hasTerminated (void) const
  • const SoPath * getCurPath (void)
  • SoState * getState (void) const
  • PathCode getCurPathCode (void) const
  • virtual SoNode * getCurPathTail (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 SoEnabledElementsList & getEnabledElements (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 SoEnabledElementsList * getClassEnabledElements (void)
  • static SoActionMethodList * getClassActionMethods (void)

💜 Static Protected Member Functions inherited from SoAction

  • static SoEnabledElementsList * getClassEnabledElements (void)
  • static SoActionMethodList * getClassActionMethods (void)

🍓 Friends

  • class SoToVRMLActionP

🌸 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 (ie neither VRML1 or VRML97 compatible nodes) is not attempted converted, they are just ignored. so heads up bestie, they don't get converted, they just get left behind 💀

🔍 See also

SoToVRML2Action

📅 Since

  • Coin 2.0
  • TGS Inventor 2.5

🛠️ Constructor & Destructor Documentation

SoToVRMLAction::SoToVRMLAction (void )

Constructor.

Referenced by addMethod().

SoToVRMLAction::~SoToVRMLAction (void ) [virtual]

The destructor.

📚 Member Function Documentation

SoType SoToVRMLAction::getTypeId (void ) const [virtual]

Returns the type identification of an action derived from a class inheriting SoAction. This is used for run-time 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 renderaction
}

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 pre-defined 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.

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.

🙈 translation: bestie, this one is internal library business, you probably don't need it.

References SoToVRMLAction().

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.

🙈 same vibe as above, it's an internal thing.

const SoEnabledElementsList & SoToVRMLAction::getEnabledElements (void ) const [protected], [virtual]

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

Reimplemented from SoAction.

Reimplemented in SoToVRML2Action.

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. undefined behavior is NOT the vibe, please don't 🙏

Reimplemented from SoAction.

Reimplemented in SoToVRML2Action.

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.

void SoToVRMLAction::apply (const SoPathList & pathlist, SbBool obeysrules = 0) [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):

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

🔍 See also

SoAction::apply(SoPath * path)

Reimplemented from SoAction.

Reimplemented in SoToVRML2Action.

void SoToVRMLAction::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.

Reimplemented in SoToVRML2Action.

✍️ Author

Generated automatically by Doxygen for Coin from the source code.

and that's the whole page, bestie 🫶 this one came from Coin, Version 2.5.0 — go forth and convert your scene graphs, you absolute icon 👑✨

📦 where this page comes from