SoType.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Nick Thompson (MMM yyyy)
** Modified by : Gavin Bell (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef _SO_TYPE_
#define _SO_TYPE_
 
#include <Inventor/SbString.h>
#include <Inventor/SbDict.h>
#include <Inventor/STL/ostream>
 
class SoTypeList;
struct SoTypeData;
class ScDataInputStream;
 
typedef void *SoTypeFromNameCB(SbName name);
 
#ifndef HIDDEN_FROM_DOC
//Int32 value of a badtype
#define SO_BAD_TYPE_INT_INTERNAL 0x80000000
#endif
 
class  SoType {
 
#ifdef __DELTA
#  pragma __nondynamic_class
#endif
 
 public:
 
  static SoType fromName(const SbName &name);
 
  SbName getName() const;
 
  SoType getParent() const;
 
  inline static SoType badType()
  {
    return (SoType)SO_BAD_TYPE_INT_INTERNAL;
  }
 
  SbBool isBad() const;
 
  SbBool isDerivedFrom(const SoType &t) const;
 
  template<typename TypedObjectClass>
  SbBool isDerivedFrom() const
  {
    return isDerivedFrom( TypedObjectClass::getClassTypeId() );
  }
 
  static int getAllDerivedFrom(const SoType &type, SoTypeList &list);
 
  SbBool canCreateInstance() const;
 
  // Internal note: Only "if_cpp" is needed here.
  //                .NET and Java API do not use this class.
 
  void *createInstance(SoType *overrideType=NULL) const;
 
  bool operator ==(const SoType t) const;
 
  bool operator !=(const SoType t) const;
 
  bool operator <(const SoType t) const;
 
   friend std::ostream& operator << (std::ostream& os, const SoType& t)
  {
    return os << "<" << t.getName() << "," << t.getKey() << ">";
  }
 
 private:
 
  // set a callback that will be called if unknown node are found
  static SoTypeFromNameCB *setUnknownNameCB(SoTypeFromNameCB *func);
 
  // Create a new type
  static SoType createType(const SoType &parent, const SbName &name,
                           void * (*createMethod)(SoType *) = NULL,
                           short data = 0);
 
  // Make an new type act like an existing type. The new type MUST
  // be a C++ subclass of the original (e.g. MyCubeClass must be
  // derived from SoCube), but there is no way for us to check that.
  // This can be used to get the database to create a different
  // subclass whenever it reads in an SoNode class from a file.
  static SoType overrideType(const SoType &existingType,
                             void * (*createMethod)(SoType *) = NULL);
 
  static SbBool removeType( const SbName &name );
 
 private:
 
  // Constructor.
  SoType() { storage.intValue = SO_BAD_TYPE_INT_INTERNAL; }
 
  SoType(unsigned int storageValue) { storage.intValue = storageValue; }
 
  // Initialize the type system
  static void init();
  static void finish();
 
  // get max key value
  static int maxKey() { return nextIndex; }
 
  // Get data
  short getData() const;
 
  // Returns the type key as a short
  short getKey() const;
 
  // Mark this type as internal; if internal, getAllDerivedFrom and
  // fromName will not return the type.
  void makeInternal();
  bool isInternal() const;
 
  // Get the number of types currently registed in the types dictionary.
  // This is used by SoAction when setting up the action method list.
  static int getNumTypes();
 
  // Get the name of the types currently registered with the key 'key'.
  static SbName getTypeName(const short key);
 
  inline unsigned int getStorageValue() const { return storage.intValue; }
 
  bool isDerivedFrom( const SbName& name ) const;
 
  static SoType getType(const SbName& name);
 
 private:
 
  // SoTypes are passed around on the stack a lot, and are cast to
  // void *'s; they MUST fit into a single word.
  union
  {
    struct {
      unsigned int data : 16;
      unsigned int index : 15; // Assumes we have fewer than 32,768 types
      unsigned int isPublic :1; // 0 if is an internal class
    } storageStruct;
    unsigned int intValue;
  } storage;
 
  // name->sotype dictionary
  static SbDict *nameDict;
 
  // array of SoTypeData
  static int nextIndex;
  static int arraySize;
  static SoTypeData *typeData;
 
  static void expandTypeData();
  static SoType fromNameExt(const SbName &name, bool extent);
 
  static SoTypeFromNameCB *unknownNameFunc;
  static void *unknownNameData;
};
 
#include <Inventor/lists/SoTypeList.h>
 
#endif /* _SO_TYPE_ */