SoType.h
#ifndef COIN_SOTYPE_H
#define COIN_SOTYPE_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/SbBasic.h>
#include <cstdlib> // For NULL definition.
#ifndef COIN_INTERNAL
// The next include for Open Inventor compatibility.
//
// FIXME: I haven't checked that this is actually required -- test vs
// SGI Inventor. 20050524 mortene.
#include <Inventor/SbDict.h>
#endif // COIN_INTERNAL
// *************************************************************************
class SbName;
class SoTypedObject;
class SoTypeList;
class SoFieldData;
class SbDict;
struct SoTypeData;
template <typename Type> class SbList;
// *************************************************************************
class COIN_DLL_API SoType {
public:
typedef void * (*instantiationMethod)(void);
static SoType fromName(const SbName name);
SbName getName(void) const;
const SoType getParent(void) const;
SbBool isDerivedFrom(const SoType type) const;
static int getAllDerivedFrom(const SoType type, SoTypeList & list);
SbBool canCreateInstance(void) const;
void * createInstance(void) const;
uint16_t getData(void) const;
int16_t getKey(void) const;
SbBool operator == (const SoType type) const;
SbBool operator != (const SoType type) const;
SbBool operator < (const SoType type) const;
SbBool operator <= (const SoType type) const;
SbBool operator >= (const SoType type) const;
SbBool operator > (const SoType type) const;
static const SoType createType(const SoType parent, const SbName name,
const instantiationMethod method = NULL,
const uint16_t data = 0);
static const SoType overrideType(const SoType originalType,
const instantiationMethod method = NULL);
static SbBool removeType(const SbName & name);
static void init(void);
static SoType fromKey(uint16_t key);
static SoType badType(void);
SbBool isBad(void) const;
void makeInternal(void);
SbBool isInternal(void) const;
static int getNumTypes(void);
instantiationMethod getInstantiationMethod(void) const;
private:
static void clean(void);
int16_t index;
static SbList<SoTypeData *> * typedatalist;
};
/* inline methods ************************************************/
inline int16_t
SoType::getKey(void) const
{
return this->index;
}
inline SbBool
SoType::operator != (const SoType type) const
{
return (this->getKey() != type.getKey());
}
inline SbBool
SoType::operator == (const SoType type) const
{
return (this->getKey() == type.getKey());
}
inline SbBool
SoType::operator < (const SoType type) const
{
return (this->getKey() < type.getKey());
}
inline SbBool
SoType::operator <= (const SoType type) const
{
return (this->getKey() <= type.getKey());
}
inline SbBool
SoType::operator >= (const SoType type) const
{
return (this->getKey() >= type.getKey());
}
inline SbBool
SoType::operator > (const SoType type) const
{
return (this->getKey() > type.getKey());
}
inline SbBool
SoType::isBad(void) const
{
return (this->index == 0);
}
#endif // !COIN_SOTYPE_H
SbDict
The SbDict class organizes a dictionary of keys and values.
Definition SbDict.h:63
SbList
The SbList class is a template container class for lists.
Definition SbList.h:70
SbName
The SbName class stores strings by reference.
Definition SbName.h:40
SoFieldData
The SoFieldData class is a container for a prototype set of fields.
Definition SoFieldData.h:48
SoTypeList
The SoTypeList class is a container class for arrays of SoType objects.
Definition SoTypeList.h:39
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59
SoType::getKey
int16_t getKey(void) const
Definition SoType.h:117
SoType::badType
static SoType badType(void)
Definition SoType.cpp:714
SoType::getParent
const SoType getParent(void) const
Definition SoType.cpp:701
SoType::canCreateInstance
SbBool canCreateInstance(void) const
Definition SoType.cpp:838
SoType::fromName
static SoType fromName(const SbName name)
Definition SoType.cpp:510
SoType::operator>=
SbBool operator>=(const SoType type) const
Definition SoType.h:147
SoType::getData
uint16_t getData(void) const
Definition SoType.cpp:689
SoType::instantiationMethod
void *(* instantiationMethod)(void)
Definition SoType.h:61
SoType::overrideType
static const SoType overrideType(const SoType originalType, const instantiationMethod method=NULL)
Definition SoType.cpp:450
SoType::init
static void init(void)
Definition SoType.cpp:228
SoType::getAllDerivedFrom
static int getAllDerivedFrom(const SoType type, SoTypeList &list)
Definition SoType.cpp:814
SoType::makeInternal
void makeInternal(void)
Definition SoType.cpp:911
SoType::removeType
static SbBool removeType(const SbName &name)
Definition SoType.cpp:317
SoType::isDerivedFrom
SbBool isDerivedFrom(const SoType type) const
Definition SoType.cpp:737
SoType::operator==
SbBool operator==(const SoType type) const
Definition SoType.h:129
SoType::getNumTypes
static int getNumTypes(void)
Definition SoType.cpp:877
SoType::getName
SbName getName(void) const
Definition SoType.cpp:675
SoType::createType
static const SoType createType(const SoType parent, const SbName name, const instantiationMethod method=NULL, const uint16_t data=0)
Definition SoType.cpp:274
SoType::fromKey
static SoType fromKey(uint16_t key)
Definition SoType.cpp:661
SoType::isInternal
SbBool isInternal(void) const
Definition SoType.cpp:921
SoType::operator!=
SbBool operator!=(const SoType type) const
Definition SoType.h:123
SoType::isBad
SbBool isBad(void) const
Definition SoType.h:159
SoType::createInstance
void * createInstance(void) const
Definition SoType.cpp:855
SoType::getInstantiationMethod
instantiationMethod getInstantiationMethod(void) const
Definition SoType.cpp:894
SoType::operator>
SbBool operator>(const SoType type) const
Definition SoType.h:153
SoType::operator<=
SbBool operator<=(const SoType type) const
Definition SoType.h:141
SoType::operator<
SbBool operator<(const SoType type) const
Definition SoType.h:135