Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoSFEnum.h
1 #ifndef COIN_SOSFENUM_H
2 #define COIN_SOSFENUM_H
3 
4 /**************************************************************************\
5  * Copyright (c) Kongsberg Oil & Gas Technologies AS
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  * Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in the
17  * documentation and/or other materials provided with the distribution.
18  *
19  * Neither the name of the copyright holder nor the names of its
20  * contributors may be used to endorse or promote products derived from
21  * this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 \**************************************************************************/
35 
36 #include <Inventor/fields/SoSField.h>
37 #include <Inventor/fields/SoSubField.h>
38 #include <Inventor/SbString.h>
39 
40 class COIN_DLL_API SoSFEnum : public SoSField {
41  typedef SoSField inherited;
42 
43  SO_SFIELD_HEADER(SoSFEnum, int, int);
44 
45 public:
46  static void initClass(void);
47 
48  void setValue(const SbName name);
49  void setEnums(const int num, const int * vals, const SbName * names);
50 
51  int getNumEnums(void) const;
52  int getEnum(const int idx, SbName & name) const;
53 
54 protected:
55  virtual SbBool findEnumValue(const SbName & name, int & val);
56  virtual SbBool findEnumName(int value, const SbName * & name) const;
57 
58  int numEnums;
59  int * enumValues;
62 };
63 
64 // These macros are called from both node and engine classes which
65 // uses SoSFEnum instances, so we put them here instead of in
66 // SoSub[Node|Engine].h.
67 
68 #define PRIVATE_SOENUM_SET_TYPE(_fieldname_, _enumtype_, _fieldstorage_) \
69  do { \
70  /* Don't need to worry about name clashes, as we're inside our own scope. */ \
71  int num; \
72  const int * values; \
73  const SbName * names; \
74  _fieldstorage_->getEnumData(SO__QUOTE(_enumtype_), num, values, names); \
75  this->_fieldname_.setEnums(num, values, names); \
76  } WHILE_0
77 
78 
79 #define SO_ENGINE_SET_SF_ENUM_TYPE(_fieldname_, _enumtype_) \
80  PRIVATE_SOENUM_SET_TYPE(_fieldname_, _enumtype_, inputdata)
81 
82 #define SO_NODE_SET_SF_ENUM_TYPE(_fieldname_, _enumtype_) \
83  PRIVATE_SOENUM_SET_TYPE(_fieldname_, _enumtype_, fieldData)
84 
85 #endif // !COIN_SOSFENUM_H
int numEnums
Definition: SoSFEnum.h:58
SbName * enumNames
Definition: SoSFEnum.h:60
The SoSField class is the base class for fields which contains only a single value.
Definition: SoSField.h:38
The SoSFEnum class is a container for an enum value.
Definition: SoSFEnum.h:40
SbBool legalValuesSet
Definition: SoSFEnum.h:61
The SbName class stores strings by reference.
Definition: SbName.h:40
int * enumValues
Definition: SoSFEnum.h:59