SoEngine.h
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#ifndef COIN_SOENGINE_H
#define COIN_SOENGINE_H
#include <Inventor/fields/SoFieldContainer.h>
class SoEngineList;
class SoEngineOutput;
class SoEngineOutputList;
class SoEngineOutputData;
class COIN_DLL_API SoEngine : public SoFieldContainer {
typedef SoFieldContainer inherited;
public:
static void initClass(void);
static void initClasses(void);
static SoType getClassTypeId(void);
void evaluateWrapper(void);
virtual int getOutputs(SoEngineOutputList & l) const;
SoEngineOutput * getOutput(const SbName & outputname) const;
SbBool getOutputName(const SoEngineOutput * output, SbName & outputname) const;
virtual const SoEngineOutputData * getOutputData(void) const = 0;
static SoEngine * getByName(const SbName & name);
static int getByName(const SbName & name, SoEngineList & el);
SbBool isNotifying(void) const;
virtual void notify(SoNotList * nl);
SoEngine * copy(void) const;
virtual SoFieldContainer * copyThroughConnection(void) const;
SbBool shouldCopy(void) const;
virtual void writeInstance(SoOutput * out);
protected:
SoEngine(void);
virtual ~SoEngine(void);
virtual void evaluate(void) = 0;
virtual SbBool readInstance(SoInput * in, unsigned short flags);
virtual void inputChanged(SoField * which);
static const SoFieldData ** getInputDataPtr(void);
static const SoEngineOutputData ** getOutputDataPtr(void);
void writeOutputTypes(SoOutput * out);
private:
virtual void destroy(void); // overrides SoBase::destroy()
static SoType classTypeId;
enum InternalEngineFlags {
FLAG_ISNOTIFYING = (1 << 0),
FLAG_ISDIRTY = (1 << 1)
};
unsigned int flags;
// needed for handling connections from SoEngineOutput
friend class SoEngineOutput;
void setDirty(void);
};
#if !defined(COIN_INTERNAL)
#include <Inventor/engines/SoEngineOutput.h>
#endif // COIN_INTERNAL
#endif // !COIN_SOENGINE_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SoBase::destroy
virtual void destroy(void)
Definition SoBase.cpp:299
SoEngineList
The SoEngineList class is a container for SoEngine objects.
Definition SoEngineList.h:40
SoEngineOutputData
The SoEngineOutputData class is a container for a prototype set of outputs.
Definition SoOutputData.h:49
SoEngineOutputList
The SoEngineOutputList class is a container for SoEngineOutput objects.
Definition SoEngineOutputList.h:40
SoEngineOutput
The SoEngineOutput class is the output slots in SoEngine instances.
Definition SoEngineOutput.h:45
SoEngine::getInputDataPtr
static const SoFieldData ** getInputDataPtr(void)
Definition SoEngine.cpp:391
SoEngine::getOutputs
virtual int getOutputs(SoEngineOutputList &l) const
Definition SoEngine.cpp:227
SoEngine::SoEngine
SoEngine(void)
Definition SoEngine.cpp:101
SoEngine::evaluateWrapper
void evaluateWrapper(void)
Definition SoEngine.cpp:360
SoEngine::copy
SoEngine * copy(void) const
Definition SoEngine.cpp:454
SoEngine::writeOutputTypes
void writeOutputTypes(SoOutput *out)
Definition SoEngine.cpp:431
SoEngine::evaluate
virtual void evaluate(void)=0
SoEngine::shouldCopy
SbBool shouldCopy(void) const
Definition SoEngine.cpp:517
SoEngine::getOutput
SoEngineOutput * getOutput(const SbName &outputname) const
Definition SoEngine.cpp:244
SoEngine::getOutputData
virtual const SoEngineOutputData * getOutputData(void) const =0
SoEngine::getOutputName
SbBool getOutputName(const SoEngineOutput *output, SbName &outputname) const
Definition SoEngine.cpp:261
SoEngine::getOutputDataPtr
static const SoEngineOutputData ** getOutputDataPtr(void)
Definition SoEngine.cpp:401
SoEngine::initClasses
static void initClasses(void)
Definition SoEngine.cpp:175
SoEngine::getByName
static SoEngine * getByName(const SbName &name)
Definition SoEngine.cpp:283
SoEngine::isNotifying
SbBool isNotifying(void) const
Definition SoEngine.cpp:545
SoEngine::inputChanged
virtual void inputChanged(SoField *which)
Definition SoEngine.cpp:304
SoFieldContainer::writeInstance
virtual void writeInstance(SoOutput *out)
Definition SoFieldContainer.cpp:733
SoFieldContainer::SoFieldContainer
SoFieldContainer(void)
Definition SoFieldContainer.cpp:133
SoFieldContainer::getClassTypeId
static SoType getClassTypeId(void)
This static method returns the SoType object associated with objects of this class.
Definition SoFieldContainer.cpp:283
SoFieldContainer::notify
virtual void notify(SoNotList *l)
Definition SoFieldContainer.cpp:654
SoFieldContainer::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoFieldContainer.cpp:241
SoFieldContainer::copyThroughConnection
virtual SoFieldContainer * copyThroughConnection(void) const
Definition SoFieldContainer.cpp:822
SoFieldContainer::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoFieldContainer.cpp:1049
SoFieldData
The SoFieldData class is a container for a prototype set of fields.
Definition SoFieldData.h:48
SoField
The SoField class is the top-level abstract base class for fields.
Definition SoField.h:47
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoNotList
The SoNotList class is a list of SoNotRec notification records.
Definition SoNotification.h:43
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59