SoAction.h
#ifndef COIN_SOACTION_H
#define COIN_SOACTION_H
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#include <Inventor/SbBasic.h>
#include <Inventor/SoType.h>
#include <Inventor/misc/SoTempPath.h>
#include <Inventor/tools/SbPimplPtr.h>
// Include instead of using forward declarations to be compatible with
// Open Inventor (and besides, all the other action class definitions
// needs to know about these lists).
#include <Inventor/lists/SoActionMethodList.h>
#include <Inventor/lists/SoEnabledElementsList.h>
// defined in Inventor/SbBasic.h
#ifdef COIN_UNDEF_IN_PATH_HACK
#include <sys/unistd.h>
#undef IN_PATH
// Avoid problem with HPUX 10.20 C library API headers, which defines IN_PATH
// in <sys/unistd.h>. That define destroys the SoAction::PathCode enum, and
// the preprocessor is so broken that we can't store/restore the define for
// the duration of this header file.
#endif // COIN_UNDEF_IN_PATH_HACK
#define SO_ENABLE(action, element) \
do { \
assert(!element::getClassTypeId().isBad()); \
action::enableElement(element::getClassTypeId(), \
element::getClassStackIndex()); \
} WHILE_0
class SoEnabledElementsList;
class SoNode;
class SoPath;
class SoPathList;
class SoState;
class SoActionP;
class COIN_DLL_API SoAction {
public:
static void initClass(void);
static void initClasses(void);
enum AppliedCode { NODE = 0, PATH = 1, PATH_LIST = 2 };
enum PathCode { NO_PATH = 0, IN_PATH = 1, BELOW_PATH = 2, OFF_PATH = 3 };
virtual ~SoAction(void);
static SoType getClassTypeId(void);
virtual SoType getTypeId(void) const = 0;
virtual SbBool isOfType(SoType type) const;
virtual void apply(SoNode * root);
virtual void apply(SoPath * path);
virtual void apply(const SoPathList & pathlist, SbBool obeysrules = FALSE);
void apply(SoAction * beingApplied);
virtual void invalidateState(void);
static void nullAction(SoAction * action, SoNode * node);
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);
public:
void switchToPathTraversal(SoPath * path);
void switchToNodeTraversal(SoNode * node);
protected:
SoAction(void);
virtual void beginTraversal(SoNode * node);
virtual void endTraversal(SoNode * node);
void setTerminated(const SbBool flag);
virtual const SoEnabledElementsList & getEnabledElements(void) const;
virtual SbBool shouldCompactPathList(void) const;
SoState * state;
SoActionMethodList * traversalMethods;
/* These two methods are not available in the original OIV API. The
reason they have been added is explained in SoSubAction.h for the
SO_ACTION_HEADER macro. */
static SoEnabledElementsList * getClassEnabledElements(void);
static SoActionMethodList * getClassActionMethods(void);
private:
static SoType classTypeId;
/* The enabledElements and methods variables are protected in the
original OIV API. This is not such a good idea, see the comments
in SoSubAction.h for SO_ACTION_HEADER. */
static void atexit_cleanup(void);
static SoEnabledElementsList * enabledElements;
static SoActionMethodList * methods;
SoTempPath currentpath;
PathCode currentpathcode;
private:
SbPimplPtr<SoActionP> pimpl;
// NOT IMPLEMENTED:
SoAction(const SoAction & rhs);
SoAction & operator = (const SoAction & rhs);
}; // SoAction
// inline methods
inline SoAction::PathCode
SoAction::getCurPathCode(void) const
{
return this->currentpathcode;
}
#endif // !COIN_SOACTION_H
SbPimplPtr
Definition SbPimplPtr.h:55
SoActionMethodList
The SoActionMethodList class contains function pointers for action methods.
Definition SoActionMethodList.h:44
SoAction
The SoAction class is the base class for all traversal actions.
Definition SoAction.h:77
SoAction::PathCode
PathCode
Definition SoAction.h:83
SoAction::pushCurPath
void pushCurPath(const int childindex, SoNode *node=NULL)
Definition SoAction.cpp:961
SoAction::AppliedCode
AppliedCode
Definition SoAction.h:82
SoAction::invalidateState
virtual void invalidateState(void)
Definition SoAction.cpp:821
SoAction::switchToPathTraversal
void switchToPathTraversal(SoPath *path)
Definition SoAction.cpp:1313
SoAction::getPathCode
PathCode getPathCode(int &numindices, const int *&indices)
Definition SoAction.cpp:928
SoAction::getState
SoState * getState(void) const
Definition SoAction.cpp:1084
SoAction::getCurPathTail
virtual SoNode * getCurPathTail(void)
Definition SoAction.cpp:1117
SoAction::getOriginalPathListAppliedTo
const SoPathList * getOriginalPathListAppliedTo(void) const
Definition SoAction.cpp:904
SoAction::isOfType
virtual SbBool isOfType(SoType type) const
Definition SoAction.cpp:449
SoAction::state
SoState * state
Definition SoAction.h:140
SoAction::shouldCompactPathList
virtual SbBool shouldCompactPathList(void) const
Definition SoAction.cpp:1303
SoAction::getClassActionMethods
static SoActionMethodList * getClassActionMethods(void)
Definition SoAction.cpp:1249
SoAction::getTypeId
virtual SoType getTypeId(void) const =0
SoAction::nullAction
static void nullAction(SoAction *action, SoNode *node)
Definition SoAction.cpp:834
SoAction::initClass
static void initClass(void)
Definition SoAction.cpp:370
SoAction::getPathListAppliedTo
const SoPathList * getPathListAppliedTo(void) const
Definition SoAction.cpp:889
SoAction::getNodeAppliedTo
SoNode * getNodeAppliedTo(void) const
Definition SoAction.cpp:855
SoAction::getWhatAppliedTo
AppliedCode getWhatAppliedTo(void) const
Definition SoAction.cpp:843
SoAction::SoAction
SoAction(void)
Definition SoAction.cpp:337
SoAction::traverse
void traverse(SoNode *const node)
Definition SoAction.cpp:940
SoAction::popCurPath
void popCurPath(const PathCode prevpathcode)
Definition SoAction.cpp:1050
SoAction::beginTraversal
virtual void beginTraversal(SoNode *node)
Definition SoAction.cpp:1269
SoAction::endTraversal
virtual void endTraversal(SoNode *node)
Definition SoAction.cpp:1279
SoAction::initClasses
static void initClasses(void)
Definition SoAction.cpp:409
SoAction::setTerminated
void setTerminated(const SbBool flag)
Definition SoAction.cpp:1294
SoAction::getCurPathCode
PathCode getCurPathCode(void) const
Definition SoAction.h:172
SoAction::getClassEnabledElements
static SoEnabledElementsList * getClassEnabledElements(void)
Definition SoAction.cpp:1237
SoAction::switchToNodeTraversal
void switchToNodeTraversal(SoNode *node)
Definition SoAction.cpp:1340
SoAction::apply
virtual void apply(SoNode *root)
Definition SoAction.cpp:463
SoAction::isLastPathListAppliedTo
SbBool isLastPathListAppliedTo(void) const
Definition SoAction.cpp:915
SoAction::popPushCurPath
void popPushCurPath(const int childindex, SoNode *node=NULL)
Definition SoAction.cpp:1193
SoAction::getEnabledElements
virtual const SoEnabledElementsList & getEnabledElements(void) const
Definition SoAction.cpp:1225
SoAction::usePathCode
void usePathCode(int &numindices, const int *&indices)
Definition SoAction.cpp:1126
SoAction::getPathAppliedTo
SoPath * getPathAppliedTo(void) const
Definition SoAction.cpp:869
SoAction::hasTerminated
SbBool hasTerminated(void) const
Definition SoAction.cpp:1074
SoAction::getCurPath
const SoPath * getCurPath(void)
Definition SoAction.cpp:1108
SoAction::traversalMethods
SoActionMethodList * traversalMethods
Definition SoAction.h:141
SoEnabledElementsList
The SoEnabledElementsList class is a container for type info for element types that are enabled in ac...
Definition SoEnabledElementsList.h:38
SoNode
The SoNode class is the base class for nodes used in scene graphs.
Definition SoNode.h:56
SoPathList
The SoPathList class is a container for pointers to SoPath objects.
Definition SoPathList.h:40
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoState
The SoState class manages the Coin scene graph traversal state data.
Definition SoState.h:44
SoTempPath
The SoTempPath class is used to store temporary paths.
Definition SoTempPath.h:38
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59