SoState.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 SoState class.
 |
 |   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_STATE_
#define  _SO_STATE_
 
 
#define SO_STATE_GET_CONST_ELEMENT(stackIndex)\
        return stack[stackIndex];
 
#include <Inventor/SoLists.h>
 
class SoAction;
class SoElement;
 
SoEXTENDER class INVENTOR_API SoState {
 
  public:
    SoState(SoAction *action, const SoTypeList &enabledElements);
 
    ~SoState();
 
    SoAction *          getAction() const       { return action; }
 
    SoElement *         getElement(int stackIndex);
 
    const SoElement *   getConstElement(int stackIndex) const
        { return stack[stackIndex]; }
 
    void                push() 
                        { depth++; }
 
    void                pop();
 
    void                print(FILE *fp);
 
  SoINTERNAL public:
    bool                isElementEnabled(int stackIndex) const
        { return (stack[stackIndex] != NULL); }
 
    int                 getDepth() const { return depth; }
 
    void                setCacheOpen(bool flag)       { cacheOpen = flag; }
    bool                isCacheOpen() const             { return cacheOpen; }
 
    SoElement *         getElementNoPush(int stackIndex) const
        { return stack[stackIndex]; }
 
  private:
    SoAction            *action;        
    int                 depth;          
    SoElement           **stack;        
    int                 numStacks;      
    SoElement *         topElement;     
 
    bool                cacheOpen;      
};
 
#endif  /* _SO_STATE_ */