Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

SoSFEnum.h

00001 /**************************************************************************\
00002  *
00003  *  This file is part of the Coin 3D visualization library.
00004  *  Copyright (C) 1998-2002 by Systems in Motion. All rights reserved.
00005  *
00006  *  This library is free software; you can redistribute it and/or
00007  *  modify it under the terms of the GNU Lesser General Public License
00008  *  version 2.1 as published by the Free Software Foundation. See the
00009  *  file LICENSE.LGPL at the root directory of the distribution for
00010  *  more details.
00011  *
00012  *  If you want to use Coin for applications not compatible with the
00013  *  LGPL, please contact SIM to acquire a Professional Edition license.
00014  *
00015  *  Systems in Motion, Prof Brochs gate 6, 7030 Trondheim, NORWAY
00016  *  http://www.sim.no support@sim.no Voice: +47 22114160 Fax: +47 22207097
00017  *
00018 \**************************************************************************/
00019 
00020 #ifndef COIN_SOSFENUM_H
00021 #define COIN_SOSFENUM_H
00022 
00023 #include <Inventor/fields/SoSField.h>
00024 #include <Inventor/fields/SoSubField.h>
00025 #include <Inventor/SbString.h>
00026 
00027 
00028 class COIN_DLL_API SoSFEnum : public SoSField {
00029   typedef SoSField inherited;
00030 
00031   SO_SFIELD_HEADER(SoSFEnum, int, int);
00032 
00033 public:
00034   static void initClass(void);
00035 
00036   void setValue(const SbName name);
00037   void setEnums(const int num, const int * vals, const SbName * names);
00038 
00039 protected:
00040   virtual SbBool findEnumValue(const SbName & name, int & val);
00041   virtual SbBool findEnumName(int value, const SbName * & name) const;
00042 
00043   int numEnums;
00044   int * enumValues;
00045   SbName * enumNames;
00046   SbBool legalValuesSet;
00047 };
00048 
00049 
00050 // These macros are called from both node and engine classes which
00051 // uses SoSFEnum instances, so we put them here instead of in
00052 // SoSub[Node|Engine].h.
00053 
00054 #define PRIVATE_SOENUM_SET_TYPE(_fieldname_, _enumtype_, _fieldstorage_) \
00055   do { \
00056     /* Don't need to worry about name clashes, as we're inside our own scope. */ \
00057     int num; \
00058     const int * values; \
00059     const SbName * names; \
00060     _fieldstorage_->getEnumData(SO__QUOTE(_enumtype_), num, values, names); \
00061     this->_fieldname_.setEnums(num, values, names); \
00062   } while (FALSE)
00063 
00064 
00065 #define SO_ENGINE_SET_SF_ENUM_TYPE(_fieldname_, _enumtype_) \
00066   PRIVATE_SOENUM_SET_TYPE(_fieldname_, _enumtype_, inputdata)
00067 
00068 #define SO_NODE_SET_SF_ENUM_TYPE(_fieldname_, _enumtype_) \
00069   PRIVATE_SOENUM_SET_TYPE(_fieldname_, _enumtype_, fieldData)
00070 
00071 
00072 
00073 #endif // !COIN_SOSFENUM_H

Generated at Tue Mar 5 03:31:17 2002 for Coin by doxygen1.2.9 written by Dimitri van Heesch, © 1997-2001