SoProto.h
#ifndef COIN_SOPROTO_H
#define COIN_SOPROTO_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.
\**************************************************************************/
#include <Inventor/nodes/SoNode.h>
class SoProto;
class SoInput;
class SoProtoInstance;
class SoProtoP;
typedef SoProto * SoFetchExternProtoCB(SoInput * in,
const SbString * urls,
const int numurls,
void * closure);
// We need to inherit SoNode to be able to insert the PROTO definition
// into the scene graph.
class COIN_DLL_API SoProto : public SoNode {
public:
SoProto(const SbBool externproto = FALSE);
static void setFetchExternProtoCallback(SoFetchExternProtoCB * cb,
void * closure);
virtual SoType getTypeId(void) const;
static SoType getClassTypeId(void);
static SoProto * findProto(const SbName & name);
static void initClass(void);
SoProtoInstance * createProtoInstance(void);
void addISReference(SoNode * container,
const SbName & fieldname,
const SbName & interfacename);
SbName findISReference(const SoFieldContainer * container,
const SbName & fieldname);
void addReference(const SbName & name, SoBase * base);
void removeReference(const SbName & name);
SoBase * findReference(const SbName & name) const;
void addRoute(const SbName & fromnode, const SbName & fromfield,
const SbName & tonode, const SbName & tofield);
SbName getProtoName(void) const;
virtual SbBool readInstance(SoInput * input, unsigned short flags);
virtual void write(SoWriteAction * action);
protected:
virtual ~SoProto();
virtual void destroy(void);
private:
SbBool writeInterface(SoOutput * out);
SbBool writeDefinition(SoWriteAction * action);
SbBool readInterface(SoInput * in);
SbBool readDefinition(SoInput * in);
SbBool writeURLs(SoOutput * out);
SoProtoP * pimpl;
friend class SoProtoP;
SbBool setupExtern(SoInput * in, SoProto * externproto);
SoNode * createInstanceRoot(SoProtoInstance * inst) const;
void connectISRefs(SoProtoInstance * inst, SoNode * src, SoNode * dst) const;
};
#endif // !COIN_SOPROTO_H
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SbString
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
SoBase::SoBase
SoBase(void)
Definition SoBase.cpp:190
SoBase::getTypeId
virtual SoType getTypeId(void) const =0
Returns the type identification of an object derived from a class inheriting SoBase....
SoBase::destroy
virtual void destroy(void)
Definition SoBase.cpp:299
SoFieldContainer::SoFieldContainer
SoFieldContainer(void)
Definition SoFieldContainer.cpp:133
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::getClassTypeId
static SoType getClassTypeId(void)
Definition SoNode.cpp:361
SoNode::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoNode.cpp:1542
SoNode::write
virtual void write(SoWriteAction *action)
Definition SoNode.cpp:1290
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoProtoInstance
The SoProtoInstance class handles PROTO instances.
Definition SoProtoInstance.h:46
SoProto
The SoProto class handles PROTO definitions.
Definition SoProto.h:50
SoProto::SoProto
SoProto(const SbBool externproto=FALSE)
Definition SoProto.cpp:271
SoProto::addRoute
void addRoute(const SbName &fromnode, const SbName &fromfield, const SbName &tonode, const SbName &tofield)
Definition SoProto.cpp:689
SoProto::findProto
static SoProto * findProto(const SbName &name)
Definition SoProto.cpp:325
SoProto::findISReference
SbName findISReference(const SoFieldContainer *container, const SbName &fieldname)
Definition SoProto.cpp:643
SoProto::removeReference
void removeReference(const SbName &name)
Definition SoProto.cpp:668
SoProto::addReference
void addReference(const SbName &name, SoBase *base)
Definition SoProto.cpp:659
SoProto::createProtoInstance
SoProtoInstance * createProtoInstance(void)
Definition SoProto.cpp:344
SoProto::addISReference
void addISReference(SoNode *container, const SbName &fieldname, const SbName &interfacename)
Definition SoProto.cpp:627
SoProto::getProtoName
SbName getProtoName(void) const
Definition SoProto.cpp:359
SoProto::findReference
SoBase * findReference(const SbName &name) const
Definition SoProto.cpp:677
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
SoWriteAction
The SoWriteAction class writes a scene graph to file.
Definition SoWriteAction.h:42