Coin Logo http://www.sim.no
http://www.coin3d.org

SoSFEnum.h
1 #ifndef COIN_SOSFENUM_H
2 #define COIN_SOSFENUM_H
3 
4 /**************************************************************************\
5  *
6  * This file is part of the Coin 3D visualization library.
7  * Copyright (C) 1998-2007 by Systems in Motion. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * ("GPL") version 2 as published by the Free Software Foundation.
12  * See the file LICENSE.GPL at the root directory of this source
13  * distribution for additional information about the GNU GPL.
14  *
15  * For using Coin with software that can not be combined with the GNU
16  * GPL, and for taking advantage of the additional benefits of our
17  * support services, please contact Systems in Motion about acquiring
18  * a Coin Professional Edition License.
19  *
20  * See http://www.coin3d.org/ for more information.
21  *
22  * Systems in Motion, Postboks 1283, Pirsenteret, 7462 Trondheim, NORWAY.
23  * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
24  *
25 \**************************************************************************/
26 
27 #include <Inventor/fields/SoSField.h>
28 #include <Inventor/fields/SoSubField.h>
29 #include <Inventor/SbString.h>
30 
31 class COIN_DLL_API SoSFEnum : public SoSField {
32  typedef SoSField inherited;
33 
34  SO_SFIELD_HEADER(SoSFEnum, int, int);
35 
36 public:
37  static void initClass(void);
38 
39  void setValue(const SbName name);
40  void setEnums(const int num, const int * vals, const SbName * names);
41 
42  int getNumEnums(void) const;
43  int getEnum(const int idx, SbName & name) const;
44 
45 protected:
46  virtual SbBool findEnumValue(const SbName & name, int & val);
47  virtual SbBool findEnumName(int value, const SbName * & name) const;
48 
49  int numEnums;
50  int * enumValues;
53 };
54 
55 // These macros are called from both node and engine classes which
56 // uses SoSFEnum instances, so we put them here instead of in
57 // SoSub[Node|Engine].h.
58 
59 #define PRIVATE_SOENUM_SET_TYPE(_fieldname_, _enumtype_, _fieldstorage_) \
60  do { \
61  /* Don't need to worry about name clashes, as we're inside our own scope. */ \
62  int num; \
63  const int * values; \
64  const SbName * names; \
65  _fieldstorage_->getEnumData(SO__QUOTE(_enumtype_), num, values, names); \
66  this->_fieldname_.setEnums(num, values, names); \
67  } while (FALSE)
68 
69 
70 #define SO_ENGINE_SET_SF_ENUM_TYPE(_fieldname_, _enumtype_) \
71  PRIVATE_SOENUM_SET_TYPE(_fieldname_, _enumtype_, inputdata)
72 
73 #define SO_NODE_SET_SF_ENUM_TYPE(_fieldname_, _enumtype_) \
74  PRIVATE_SOENUM_SET_TYPE(_fieldname_, _enumtype_, fieldData)
75 
76 #endif // !COIN_SOSFENUM_H
int numEnums
Definition: SoSFEnum.h:49
SbName * enumNames
Definition: SoSFEnum.h:51
The SoSField class is the base class for fields which contains only a single value.All field types which should always contain only a single member value inherits this class. SoSField is an abstract class.
Definition: SoSField.h:29
The SoSFEnum class is a container for an enum value.This field is used where nodes, engines or other field containers needs to store one particular value out of an enumerated set.
Definition: SoSFEnum.h:31
SbBool legalValuesSet
Definition: SoSFEnum.h:52
The SbName class stores strings by reference.The class is used by Coin for storing keywords...
Definition: SbName.h:31
int * enumValues
Definition: SoSFEnum.h:50

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Fri Feb 17 2017 for Coin by Doxygen. 1.8.13