MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/elements/SoElement.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:
 |      This file defines the abstract base SoEXTENDER SoElement class.
 |
 |   Classes:
 |      SoElement
 |
 |   Author(s)          : Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_ELEMENT
#define  _SO_ELEMENT

#include <Inventor/system/SbSystem.h>

#include <Inventor/SoType.h>
#include <Inventor/misc/SoState.h>
#include <Inventor/nodes/SoNode.h>

class SoTypeList;

SoEXTENDER class INVENTOR_API SoElement {

  public:
    virtual void        init(SoState *state);

    virtual void        push(SoState *state);
    virtual void        pop(SoState *state, const SoElement *prevTopElement);

    virtual void        print(FILE *fp) const;

    virtual SbBool      matches(const SoElement *elt) const = 0;

    virtual SoElement   *copyMatchInfo() const = 0;

    static SoType       getClassTypeId()        { return classTypeId; }

    SoType              getTypeId() const       { return typeId; }

  SoINTERNAL public:
    static void         initElements();

    static void         initClass();

    static int          getNumStackIndices()    { return nextStackIndex; }

    static SoType       getIdFromStackIndex(int stackIndex);

    int                 getStackIndex() const   { return stackIndex; }

    void                setDepth(int dpth)              { depth = dpth; }
    void                setNext(SoElement *nxt)         { next = nxt; }
    void                setNextInStack(SoElement *nxt)  { nextInStack = nxt; }
    void                setNextFree(SoElement *nxt)     { nextFree = nxt; }

    int                 getDepth() const        { return depth; }
    SoElement *         getNext()  const        { return next; }

    virtual ~SoElement();

  protected:
    SoElement();

    static SoElement *  getElement(SoState *state, int stackIndex)
        { return state->getElement(stackIndex); }

    static inline const SoElement * getConstElement(SoState *state,
                                                    int stackIndex);

    void                capture(SoState *state) const
        { if (state->isCacheOpen()) captureThis(state); }

    virtual void        captureThis(SoState *state) const;

    void                setTypeId(SoType id)            { typeId = id; }

    void                setStackIndex(int index)        { stackIndex = index; }

    SoElement *         getNextInStack() const          { return nextInStack; }

    SoElement *         getNextFree() const             { return nextFree; }

  SoINTERNAL protected:
    static int          classStackIndex;  

    static int          createStackIndex(SoType id);

  private:
    static SoType       classTypeId;    
    SoType              typeId;         

    static int          nextStackIndex; 
    static SoTypeList   *stackToType;   
    int                 stackIndex;     



    SoElement           *nextInStack;   
    SoElement           *nextFree;      

    SoElement           *next;          

    int                 depth;          
friend class SoState;
};


inline const SoElement *SoElement::getConstElement(SoState *state,
                                                   int stackIndex)
{
    const SoElement * elt = (state->getConstElement(stackIndex));
    elt->capture(state);
    return elt;
}

#endif /* _SO_ELEMENT */