SoAction.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Defines the SoAction class and related classes.
 |
 |   Author(s)          : Paul S. Strauss, Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_ACTION_
#define  _SO_ACTION_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/misc/SoBasic.h>
#include <Inventor/misc/SoTempPath.h>
#include <Inventor/SoPath.h>
 
class SoAction;
class SoCompactPathList;
class SoNode;
class SoState;
class SoLightweightPath;
 
typedef void    (*SoActionMethod)(SoAction *, SoNode *);
 
 
 
SoINTERNAL class INVENTOR_API SoActionMethodList : public SbPList {
 
  public:
    SoActionMethodList(SoActionMethodList *parentList);
 
    SoActionMethod &    operator [](int i) const
        { return ((SoActionMethod &)((*(const SbPList *)this)[i])); }
 
    void                addMethod(SoType nodeType, SoActionMethod method);
    
    void                setUp();
 
  private:
    SoActionMethod      parentMethod(SoType);   
    SoActionMethodList  *parent;
    int                 numValidTypes;   
 
    static void         dummyAction(SoAction *, SoNode *);
 
};
 
 
SoINTERNAL class INVENTOR_API SoEnabledElementsList {
 
  public:
    SoEnabledElementsList(SoEnabledElementsList *parentList);
 
    const SoTypeList &  getElements() const;
 
    void                enable(SoType elementType, int stackIndex);
 
    void                merge(const SoEnabledElementsList &list);
 
    static int          getCounter()            { return counter; }
 
  private:
    static int          counter;
 
    int                 setUpCounter;
 
    SoTypeList          elements;
 
    SoEnabledElementsList       *parent;
};
 
 
 
 
class INVENTOR_API SoAction {
 
  public:
 
    virtual ~SoAction();
 
    static SoType       getClassTypeId()
                            { return classTypeId; }
 
    virtual SoType      getTypeId() const = 0;
 
    bool                isOfType(SoType type) const;
 
    
    virtual void        apply(SoNode *node);
 
    virtual void        apply(SoPath *path);
 
    virtual void        apply(const SoPathList &pathList,
                              bool obeysRules = FALSE);
 
    virtual void        invalidateState();
    
  SoEXTENDER public:
 
    static void         nullAction(SoAction *, SoNode *);
 
    enum AppliedCode {
        NODE,                   
        PATH,                   
        PATH_LIST               
    };
 
    enum PathCode {
        NO_PATH,                
        IN_PATH,                
        BELOW_PATH,             
        OFF_PATH                
    };
 
    AppliedCode         getWhatAppliedTo() const   { return appliedTo.code; }
 
    SoNode *            getNodeAppliedTo() const  { return appliedTo.node; }
    SoPath *            getPathAppliedTo() const  { return appliedTo.path; }
    const SoPathList *  getPathListAppliedTo() const
        { return appliedTo.pathList; }
    const SoPathList *  getOriginalPathListAppliedTo() const
        { return appliedTo.origPathList; }
    bool                isLastPathListAppliedTo() const
        { return appliedTo.isLastPathList; }
 
    PathCode    getPathCode(int &numIndices, const int *&indices)
        {   if (appliedTo.curPathCode == IN_PATH) {
                usePathCode(numIndices, indices);
            }
            return appliedTo.curPathCode;
        }
 
 
    void                traverse(SoNode *node);
 
    bool                hasTerminated() const   { return terminated; }
 
    const SoPath *      getCurPath();
 
    SoState *           getState() const        { return state; }
 
  SoINTERNAL public:
    static void         initClass();
 
    static void         initClasses();
 
    PathCode            getCurPathCode() const { return appliedTo.curPathCode;}
    void                pushCurPath(int childIndex);
    void                popCurPath(PathCode prevPathCode);
    virtual SoNode *    getCurPathTail();                       
 
    void                usePathCode(int &numIndices, const int *&indices);
 
 
 
    void                pushCurPath()
                        { curPath.append(-1); }
    void                popPushCurPath(int childIndex)
                        { curPath.setTail(childIndex);}
    void                popCurPath()
                        { curPath.pop(); }
 
    const SoLightweightPath& getCurrentLightweightPath() const { return curPath; }
 
    void setCurrentLightweightPath(const SoLightweightPath& path) { curPath = path; }
 
  protected:
    SoAction();
 
    virtual const SoEnabledElementsList & getEnabledElements() const;
 
    virtual void        beginTraversal(SoNode *node);
 
    void                setTerminated(bool flag)      { terminated = flag; }
 
    virtual bool        shouldCompactPathLists() const;
 
  SoINTERNAL protected:    
    SoState             *state;         
 
    SoActionMethodList  *traversalMethods;
 
    static SoEnabledElementsList *enabledElements;
 
    static SoActionMethodList *methods;
 
  private:
    static SoType       classTypeId;            
 
    struct AppliedTo {
        AppliedCode             code;
        SoNode                  *node;          
        SoPath                  *path;          
        const SoPathList        *pathList;      
        const SoPathList        *origPathList;
        SoCompactPathList       *compactPathList;
        bool                     isLastPathList;
        PathCode                curPathCode;
    }                   appliedTo;
 
    bool                isBeingApplied;
 
    SoLightweightPath         curPath;
 
    SoTempPath  *       tempPath;
 
 
    int                 enabledElementsCounter;
 
    bool                terminated;
 
    int                 index;
 
    void                setUpState();
 
    void                cleanUp();
 
    void                splitPathList(const SoPathList &sortedList,
                                      const SoPathList &origPathList);
 
    void                apply(const SoPathList &sortedList,
                              const SoPathList &origPathList,
                              bool isLastPathList);
 
friend class SoDB;
};
 
 
#define SO_ENABLE(actionClass, elementClass)                            \
        actionClass::enableElement(elementClass::getClassTypeId(),      \
                                   elementClass::getClassStackIndex())
 
 
#endif /* _SO_ACTION_ */