SoType.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Defines the SoType class.  The SoType class is used for
 |       run-time typing.  It is designed to be very small (it
 |       contains only two shorts) and to support comparison of types,
 |       single inheritence type hierarchies, and creation of a type
 |       from a name and create of a C++ instance from an SoType.
 |       No two types can share the same name, even if they are
 |       derived from different parents.
 |       SoTypes may also store an extra short with the type;
 |       this is used by nodes and actions to keep track of their
 |       place in the dispatch table.
 |
 |   Author(s)          : Nick Thompson, Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_TYPE_
#define  _SO_TYPE_
 
#include <Inventor/system/SbSystem.h>
#include <Inventor/misc/SoBasic.h>
#include <Inventor/SbString.h>
#include <Inventor/SbDict.h>
 
class SoTypeList;
struct SoTypeData;
 
 
 
class INVENTOR_API SoType {
  public:
 
    static SoType       fromName(SbName name);
 
    SbName              getName() const;
 
    SoType              getParent() const;
 
    static SoType       badType();
 
    bool                isBad() const
        { return (storage.index == 0); }
 
    bool                isDerivedFrom(SoType t) const;
 
    static int          getAllDerivedFrom(SoType type,
                                          SoTypeList &list);
 
    bool                canCreateInstance() const;
 
    void *              createInstance() const;
 
    bool                   operator ==(const SoType t) const
        { return (storage.index == t.storage.index);}
    bool                   operator !=(const SoType t) const
        { return (storage.index != t.storage.index);}
 
    bool                   operator <(const SoType t) const
        { return (storage.index < t.storage.index); }
 
  SoEXTENDER public:
 
    static SoType       createType(SoType parent, SbName name,
                                   void * (*createMethod)() = NULL,
                                   short data = 0);
 
    static SoType       overrideType(SoType existingType,
                                     void * (*createMethod)() = NULL);
 
  SoINTERNAL public:
    static void         init();
 
    short               getData() const         { return storage.data; }
 
    short               getKey() const          { return storage.index; }
 
    void                makeInternal();
 
    static int          getNumTypes()           { return nextIndex; }
 
  private:
    struct {
        unsigned int    data : 16;
        unsigned int    index : 15;  
        unsigned int    isPublic :1; 
    } storage;
 
    static SbDict       *nameDict;
 
    static int          nextIndex;
    static int          arraySize;
    static SoTypeData   *typeData;
 
    static void         expandTypeData();
};
 
#endif /* _SO_TYPE_ */