SoNode.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 base SoNode class.
 |
 |   Author(s)          : Paul S. Strauss, Nick Thompson
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_NODE_
#define  _SO_NODE_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/fields/SoFieldContainer.h>
#include <Inventor/SoLists.h>
#include <Inventor/SbString.h>
#include <Inventor/SoType.h>
 
class SoAction;
class SoCallbackAction;
class SoChildList;
class SoFieldData;
class SoGLRenderAction;
class SoGetBoundingBoxAction;
class SoGetMatrixAction;
class SoHandleEventAction;
class SoInput;
class SoOutput;
class SoPickAction;
class SoRayPickAction;
class SoSearchAction;
class SoWriteAction;
 
 


 
class INVENTOR_API SoNode : public SoFieldContainer {
 
  public:

    void                setOverride(bool state);

    bool                isOverride() const              { return override; }

    static SoType       getClassTypeId()        { return classTypeId; }

    SoNode *            copy(bool copyConnections = FALSE) const;

    virtual bool        affectsState() const;

    static SoNode *     getByName(const SbName &name);
    static int          getByName(const SbName &name, SoNodeList &list);
 
  SoEXTENDER public:

    virtual void        doAction(SoAction *action);

    virtual void        GLRender(SoGLRenderAction *action);
    virtual void        callback(SoCallbackAction *action);
    virtual void        getBoundingBox(SoGetBoundingBoxAction *action);
    virtual void        getMatrix(SoGetMatrixAction *action);
    virtual void        handleEvent(SoHandleEventAction *action);
    virtual void        pick(SoPickAction *action);
    virtual void        rayPick(SoRayPickAction *action);
    virtual void        search(SoSearchAction *action);
    virtual void        write(SoWriteAction *action);

    virtual void        GLRenderBelowPath(SoGLRenderAction *action);
    virtual void        GLRenderInPath(SoGLRenderAction *action);
    virtual void        GLRenderOffPath(SoGLRenderAction *action);

    virtual void        grabEventsSetup();
    virtual void        grabEventsCleanup();
 
  SoINTERNAL public:
    enum Stage {
        FIRST_INSTANCE,         
        PROTO_INSTANCE,         
        OTHER_INSTANCE          
    };

    static void         initClass();

    static void         initClasses();

    virtual void        startNotify();

    virtual void        notify(SoNotList *list);

    SbNodeIdType          getNodeId() const       { return uniqueId; }

    static SbNodeIdType     getNextNodeId() { return nextUniqueId; }

    virtual SoChildList *getChildren() const;

    virtual void        writeInstance(SoOutput *out);

    static int          getActionMethodIndex(SoType t)
            { return t.getData(); }

    virtual SoNode *    addToCopyDict() const;

    virtual void        copyContents(const SoFieldContainer *fromFC,
                                     bool copyConnections);

    virtual SoFieldContainer *  copyThroughConnection() const;
 
  protected:
    static const SoFieldData **getFieldDataPtr() { return NULL; }

    SoNode();
    virtual ~SoNode();

    SbNodeIdType    uniqueId;

    static SbNodeIdType nextUniqueId;

    static int          nextActionMethodIndex;
 
  private:
    static SoType       classTypeId;    
 
    bool                override;       

    static void         callbackS(SoAction *, SoNode *);
    static void         GLRenderS(SoAction *, SoNode *);
    static void         getBoundingBoxS(SoAction *, SoNode *);
    static void         getMatrixS(SoAction *, SoNode *);
    static void         handleEventS(SoAction *, SoNode *);
    static void         pickS(SoAction *, SoNode *);
    static void         rayPickS(SoAction *, SoNode *);
    static void         searchS(SoAction *, SoNode *);
    static void         writeS(SoAction *, SoNode *);
};
 
#endif /* _SO_NODE_ */