SoSFEnum.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 $
 |
 |   Classes:
 |      SoSFEnum
 |
 |   Macros:
 |
 |      SO_NODE_SET_SF_ENUM_TYPE(fieldName, enumType)
 |      SO_ENGINE_SET_SF_ENUM_TYPE(fieldName, enumType)
 |              These assign a specific type of enum to an SFEnum field.
 |
 |   Author(s)          : Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_SF_ENUM_
#define  _SO_SF_ENUM_
 
#include <Inventor/SbString.h>
#include <Inventor/errors/SoDebugError.h>
#include <Inventor/fields/SoSubField.h>
 
 
 
 
class INVENTOR_API SoSFEnum : public SoSField {
    SO_SFIELD_HEADER(SoSFEnum, int, int);
 
  public:
 
    void                setValue(const SbName &name);
 
  SoEXTENDER public:
 
    void                setEnums(int num, int *vals, SbName *names);
 
  SoINTERNAL public:
    static void         initClass();
 
  protected:
    bool                legalValuesSet; 
    int                 numEnums;       
    int                 *enumValues;    
    SbName              *enumNames;     
 
    virtual bool        findEnumValue(const SbName &name, int &val);
 
    virtual bool        findEnumName(int val, const SbName *&name) const;
};
 
 
#ifdef DEBUG
#define SO__SF_ENUM_CHECK_DATA(vals, typeName, fieldName, containerMacroName) {  \
        if (vals == NULL && firstInstance)                                    \
            SoDebugError::post("SO_SET_SF_ENUM_TYPE",                         \
                               "Field %s (%s, line %d): Did you forget to"    \
                               " use SO_%s_DEFINE_ENUM_VALUE(%s, ...)?",      \
                               fieldName, __FILE__, __LINE__,                 \
                               containerMacroName, typeName);                 \
    }
#else
#define SO__SF_ENUM_CHECK_DATA(vals, typeName, fieldName, containerMacroName)   { int _value_false= 0; while(_value_false) {} }
#endif
        
 
 
#define SO__SF_ENUM_SET_TYPE(fieldName, enumType, contMacroName, contData) {  \
        int _so_sf_enum_num;                                                  \
        int *_so_sf_enum_vals;                                                \
        SbName *_so_sf_enum_names;                                            \
        contData->getEnumData(SO__QUOTE(enumType),                            \
                                _so_sf_enum_num,                              \
                                _so_sf_enum_vals,                             \
                                _so_sf_enum_names);                           \
        SO__SF_ENUM_CHECK_DATA(_so_sf_enum_vals,                              \
                               SO__QUOTE(enumType),                           \
                               SO__QUOTE(fieldName),                          \
                               contMacroName);                                \
        fieldName.setEnums(_so_sf_enum_num,                                   \
                           _so_sf_enum_vals,                                  \
                           _so_sf_enum_names);                                \
    }
 
#define SO_NODE_SET_SF_ENUM_TYPE(fieldName, enumType)                         \
    SO__SF_ENUM_SET_TYPE(fieldName,enumType,"NODE",fieldData)
 
#define SO_ENGINE_SET_SF_ENUM_TYPE(fieldName, enumType)                       \
    SO__SF_ENUM_SET_TYPE(fieldName,enumType,"ENGINE",inputData)
 
 
 
template<typename T>
class SoSFTypedEnum : public SoSFEnum {
public:
  inline void setValue(T val) { SoSFEnum::setValue(val); }
  inline T getValue() const { return static_cast<T>(SoSFEnum::getValue()); }
};
 
#endif /* _SO_SF_ENUM_ */