Coin Logo http://www.sim.no
http://www.coin3d.org

SoEngine.h

00001 /**************************************************************************\
00002  *
00003  *  This file is part of the Coin 3D visualization library.
00004  *  Copyright (C) 1998-2007 by Systems in Motion.  All rights reserved.
00005  *
00006  *  This library is free software; you can redistribute it and/or
00007  *  modify it under the terms of the GNU General Public License
00008  *  ("GPL") version 2 as published by the Free Software Foundation.
00009  *  See the file LICENSE.GPL at the root directory of this source
00010  *  distribution for additional information about the GNU GPL.
00011  *
00012  *  For using Coin with software that can not be combined with the GNU
00013  *  GPL, and for taking advantage of the additional benefits of our
00014  *  support services, please contact Systems in Motion about acquiring
00015  *  a Coin Professional Edition License.
00016  *
00017  *  See http://www.coin3d.org/ for more information.
00018  *
00019  *  Systems in Motion, Postboks 1283, Pirsenteret, 7462 Trondheim, NORWAY.
00020  *  http://www.sim.no/  sales@sim.no  coin-support@coin3d.org
00021  *
00022 \**************************************************************************/
00023 
00024 #ifndef COIN_SOENGINE_H
00025 #define COIN_SOENGINE_H
00026 
00027 #include <Inventor/fields/SoFieldContainer.h>
00028 
00029 class SoEngineList;
00030 class SoEngineOutput;
00031 class SoEngineOutputList;
00032 class SoEngineOutputData;
00033 
00034 class COIN_DLL_API SoEngine : public SoFieldContainer {
00035   typedef SoFieldContainer inherited;
00036 
00037 public:
00038   static void initClass(void);
00039   static void initClasses(void);
00040   static SoType getClassTypeId(void);
00041 
00042   void evaluateWrapper(void);
00043 
00044   virtual int getOutputs(SoEngineOutputList & l) const;
00045   SoEngineOutput * getOutput(const SbName & outputname) const;
00046   SbBool getOutputName(const SoEngineOutput * output, SbName & outputname) const;
00047   virtual const SoEngineOutputData * getOutputData(void) const = 0;
00048   static SoEngine * getByName(const SbName & name);
00049   static int getByName(const SbName & name, SoEngineList & el);
00050 
00051   SbBool isNotifying(void) const;
00052   virtual void notify(SoNotList * nl);
00053 
00054   SoEngine * copy(void) const;
00055   virtual SoFieldContainer * copyThroughConnection(void) const;
00056   SbBool shouldCopy(void) const;
00057 
00058   virtual void writeInstance(SoOutput * out);
00059 
00060 
00061 protected:
00062   SoEngine(void);
00063   virtual ~SoEngine();
00064   virtual void evaluate(void) = 0;
00065 
00066   virtual SbBool readInstance(SoInput * in, unsigned short flags);
00067   virtual void inputChanged(SoField * which);
00068 
00069   static const SoFieldData ** getInputDataPtr(void);
00070   static const SoEngineOutputData ** getOutputDataPtr(void);
00071 
00072   void writeOutputTypes(SoOutput * out);
00073 
00074 private:
00075   virtual void destroy(void); // overrides SoBase::destroy()
00076 
00077   static SoType classTypeId;
00078 
00079   enum InternalEngineFlags {
00080     FLAG_ISNOTIFYING = (1 << 0),
00081     FLAG_ISDIRTY = (1 << 1)
00082   };
00083 
00084   unsigned int flags;
00085 
00086   // needed for handling connections from SoEngineOutput
00087   friend class SoEngineOutput;
00088   void setDirty(void);
00089 };
00090 
00091 #if !defined(COIN_INTERNAL)
00092 #include <Inventor/engines/SoEngineOutput.h>
00093 #endif // COIN_INTERNAL
00094 
00095 #endif // !COIN_SOENGINE_H

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:11:54 for Coin by Doxygen. 1.7.3