SoBase.h
#ifndef COIN_SOBASE_H
#define COIN_SOBASE_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/SoType.h>
#include <Inventor/lists/SoAuditorList.h>
#include <Inventor/C/base/rbptree.h>
class SbString;
class SoBaseList;
class SoInput;
class SoOutput;
class COIN_DLL_API SoBase {
public:
static void initClass(void);
void ref(void) const;
void unref(void) const;
void unrefNoDelete(void) const;
int32_t getRefCount(void) const;
void touch(void);
virtual SoType getTypeId(void) const = 0;
SbBool isOfType(SoType type) const;
static SoType getClassTypeId(void);
virtual SbName getName(void) const;
virtual void setName(const SbName & newname);
static void addName(SoBase * const base, const char * const name);
static void removeName(SoBase * const base, const char * const name);
virtual void startNotify(void);
virtual void notify(SoNotList * l);
void addAuditor(void * const auditor, const SoNotRec::Type type);
void removeAuditor(void * const auditor, const SoNotRec::Type type);
const SoAuditorList & getAuditors(void) const;
virtual void addWriteReference(SoOutput * out, SbBool isfromfield = FALSE);
SbBool shouldWrite(void);
static void incrementCurrentWriteCounter(void);
static void decrementCurrentWriteCounter(void);
static SoBase * getNamedBase(const SbName & name, SoType type);
static int getNamedBases(const SbName & name, SoBaseList & baselist,
SoType type);
static SbBool read(SoInput * input, SoBase *& base, SoType expectedtype);
static void setInstancePrefix(const SbString & c);
static void setTraceRefs(SbBool trace);
static SbBool getTraceRefs(void);
static SbBool connectRoute(SoInput * input,
const SbName & fromnodename, const SbName & fromfieldname,
const SbName & tonodename, const SbName & tofieldname);
void assertAlive(void) const;
static SbBool readRoute(SoInput * input);
protected:
// Note: these are bitflags.
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 };
SoBase(void);
virtual ~SoBase();
virtual void destroy(void);
SbBool hasMultipleWriteRefs(void) const;
SbBool writeHeader(SoOutput * out, SbBool isgroup, SbBool isengine) const;
void writeFooter(SoOutput * out) const;
virtual const char * getFileFormatName(void) const;
virtual SbBool readInstance(SoInput * input, unsigned short flags) = 0;
static uint32_t getCurrentWriteCounter(void);
static void staticDataLock(void);
static void staticDataUnlock(void);
virtual SoNotRec createNotRec(void);
private:
static void cleanClass(void);
static SoType classTypeId;
struct {
mutable signed int referencecount : 28;
mutable unsigned int alive : 4;
} objdata;
void doNotify(SoNotList * l, const void * auditor, const SoNotRec::Type type);
cc_rbptree auditortree;
class PImpl;
friend class PImpl; // MSVC6
};
// support for boost::intrusive_ptr<SoBase>
inline void intrusive_ptr_add_ref(SoBase * obj) { obj->ref(); }
inline void intrusive_ptr_release(SoBase * obj) { obj->unref(); }
#endif // !COIN_SOBASE_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
SoAuditorList
The SoAuditorList class is used to keep track of auditors for certain object classes.
Definition lists/SoAuditorList.h:52
SoBaseList
The SoBaseList class is a container for pointers to SoBase derived objects.
Definition SoBaseList.h:41
SoBase
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition SoBase.h:45
SoBase::read
static SbBool read(SoInput *input, SoBase *&base, SoType expectedtype)
Definition SoBase.cpp:1053
SoBase::getName
virtual SbName getName(void) const
Definition SoBase.cpp:651
SoBase::setInstancePrefix
static void setInstancePrefix(const SbString &c)
Definition SoBase.cpp:1155
SoBase::unref
void unref(void) const
Definition SoBase.cpp:530
SoBase::unrefNoDelete
void unrefNoDelete(void) const
Definition SoBase.cpp:571
SoBase::SoBase
SoBase(void)
Definition SoBase.cpp:190
SoBase::removeAuditor
void removeAuditor(void *const auditor, const SoNotRec::Type type)
Definition SoBase.cpp:847
SoBase::removeName
static void removeName(SoBase *const base, const char *const name)
Definition SoBase.cpp:778
SoBase::BaseFlags
BaseFlags
Definition SoBase.h:98
SoBase::setTraceRefs
static void setTraceRefs(SbBool trace)
Definition SoBase.cpp:1171
SoBase::addWriteReference
virtual void addWriteReference(SoOutput *out, SbBool isfromfield=FALSE)
Definition SoBase.cpp:904
SoBase::getNamedBases
static int getNamedBases(const SbName &name, SoBaseList &baselist, SoType type)
Definition SoBase.cpp:1000
SoBase::shouldWrite
SbBool shouldWrite(void)
Definition SoBase.cpp:942
SoBase::staticDataLock
static void staticDataLock(void)
Definition SoBase.cpp:1544
SoBase::getAuditors
const SoAuditorList & getAuditors(void) const
Definition SoBase.cpp:869
SoBase::incrementCurrentWriteCounter
static void incrementCurrentWriteCounter(void)
Definition SoBase.cpp:951
SoBase::getClassTypeId
static SoType getClassTypeId(void)
This static method returns the SoType object associated with objects of this class.
Definition SoBase.cpp:641
SoBase::addName
static void addName(SoBase *const base, const char *const name)
Definition SoBase.cpp:748
SoBase::staticDataUnlock
static void staticDataUnlock(void)
Definition SoBase.cpp:1555
SoBase::getCurrentWriteCounter
static uint32_t getCurrentWriteCounter(void)
Definition SoBase.cpp:1373
SoBase::getRefCount
int32_t getRefCount(void) const
Definition SoBase.cpp:592
SoBase::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoBase.cpp:351
SoBase::decrementCurrentWriteCounter
static void decrementCurrentWriteCounter(void)
Definition SoBase.cpp:960
SoBase::notify
virtual void notify(SoNotList *l)
Definition SoBase.cpp:808
SoBase::isOfType
SbBool isOfType(SoType type) const
Returns TRUE if the type of this object is either of the same type or inherited from type.
Definition SoBase.cpp:631
SoBase::assertAlive
void assertAlive(void) const
Definition SoBase.cpp:450
SoBase::createNotRec
virtual SoNotRec createNotRec(void)
Definition SoBase.cpp:1565
SoBase::getTypeId
virtual SoType getTypeId(void) const =0
Returns the type identification of an object derived from a class inheriting SoBase....
SoBase::readRoute
static SbBool readRoute(SoInput *input)
Definition SoBase.cpp:1412
SoBase::setName
virtual void setName(const SbName &newname)
Definition SoBase.cpp:685
SoBase::touch
void touch(void)
Definition SoBase.cpp:606
SoBase::ref
void ref(void) const
Definition SoBase.cpp:478
SoBase::connectRoute
static SbBool connectRoute(SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
Definition SoBase.cpp:1389
SoBase::getNamedBase
static SoBase * getNamedBase(const SbName &name, SoType type)
Definition SoBase.cpp:974
SoBase::startNotify
virtual void startNotify(void)
Definition SoBase.cpp:792
SoBase::getTraceRefs
static SbBool getTraceRefs(void)
Definition SoBase.cpp:1182
SoBase::addAuditor
void addAuditor(void *const auditor, const SoNotRec::Type type)
Definition SoBase.cpp:832
SoBase::readInstance
virtual SbBool readInstance(SoInput *input, unsigned short flags)=0
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
SoNotRec
The SoNotRec class specifies records for notification lists.
Definition SoNotRec.h:42
SoNotRec::Type
Type
Definition SoNotRec.h:44
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
cc_rbptree
Definition rbptree.h:47