MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/engines/SoEngine.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 SoEngine class, and the
 |      SoEngineOutput class.
 |
 |   Author(s)          : Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_ENGINE_
#define  _SO_ENGINE_

#include <Inventor/fields/SoFieldContainer.h>
#include <Inventor/SoLists.h>
#include <Inventor/SbString.h>
#include <Inventor/SoType.h>



class SoFieldData;
class SoEngineList;
class SoEngineOutput;
class SoEngineOutputList;
class SoEngineOutputData;
class SoField;
class SoOutput;
class SoInput;




class INVENTOR_API SoEngine : public SoFieldContainer {

  public:

    static SoType       getClassTypeId() { return classTypeId; }

    virtual int         getOutputs(SoEngineOutputList &list) const;

    SoEngineOutput *    getOutput(const SbName &outputName) const;

    SbBool              getOutputName(const SoEngineOutput *output,
                                     SbName &outputName) const;

    SoEngine *          copy() const;

    static SoEngine *   getByName(const SbName &name);
    static int          getByName(const SbName &name, SoEngineList &list);

  protected:

    virtual void        evaluate() = 0;

  SoINTERNAL public:

    void                evaluateWrapper();

    virtual void        notify(SoNotList *list);

    static void         initClass();

    virtual const SoEngineOutputData *getOutputData() const = 0;

    static void         initClasses();

    virtual void        writeInstance(SoOutput *out);

    virtual SoFieldContainer *  copyThroughConnection() const;

    SbBool              shouldCopy() const;

    SbBool              isNotifying() const { return notifying; }

  protected:

    SoEngine();
    ~SoEngine();

    virtual SbBool      readInstance(SoInput *in, unsigned short flags);

    virtual void        inputChanged(SoField *whichField);

    static const SoFieldData            **getInputDataPtr()  { return NULL; }
    static const SoEngineOutputData     **getOutputDataPtr() { return NULL; }

    void                writeOutputTypes(SoOutput *out);

  private:
    static SoType       classTypeId;            

    SbBool              needsEvaluation;        
    SbBool              notifying;
friend class SoEngineOutput;
};





class INVENTOR_API SoEngineOutput {

  public:

    SoType              getConnectionType() const;

    int                 getForwardConnections(SoFieldList &list) const;

    void                enable(SbBool flag);
    SbBool              isEnabled() const       { return enabled; }

    SoEngine *          getContainer() const            { return container; }

  SoINTERNAL public:
    SoEngineOutput();

    virtual ~SoEngineOutput();

    void                setContainer(SoEngine *eng)     { container = eng; }

    void                addConnection(SoField *);
    void                removeConnection(SoField *);

    int                 getNumConnections() const
        { return connections.getLength(); }

    SoField *           operator[](int i) const
        { return connections.get(i); }

    void                prepareToWrite() const;
    void                doneWriting() const;

  private:
    SbBool              enabled;
    SoFieldList         connections;
    SoEngine            *container;
};

#endif /* _SO_ENGINE_ */