Coin: SoMField.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoMField.h
1#ifndef COIN_SOMFIELD_H
2#define COIN_SOMFIELD_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/SoField.h>
37
38class SoInput;
39class SoOutput;
40
41 class COIN_DLL_API SoMField : public SoField {
42 typedef SoField inherited;
43
44public:
45 virtual ~SoMField();
46
47 static SoType getClassTypeId(void);
48 static void atexit_cleanup(void);
49
50 int getNum(void) const;
51 void setNum(const int num);
52
53 virtual void deleteValues(int start, int num = -1);
54 virtual void insertSpace(int start, int num);
55
56 SbBool set1(const int index, const char * const valuestring);
57 void get1(const int index, SbString & valuestring);
58
59 static void initClass(void);
60
61 virtual void enableDeleteValues(void);
62 virtual SbBool isDeleteValuesEnabled(void) const;
63
64protected:
65 SoMField(void);
66 virtual void makeRoom(int newnum);
67
68#ifndef DOXYGEN_SKIP_THIS // Internal methods.
69 virtual int fieldSizeof(void) const = 0;
70 virtual void * valuesPtr(void) = 0;
71 virtual void setValuesPtr(void * ptr) = 0;
72 virtual void allocValues(int num);
73#endif // DOXYGEN_SKIP_THIS
74
75 virtual SoNotRec createNotRec(SoBase * container);
76
77 void setChangedIndex(const int chgidx);
78 void setChangedIndices(const int chgidx = -1, const int numchgind = 0);
79
80 int num;
81 int maxNum;
82 SbBool userDataIsUsed;
83
84private:
85 virtual void deleteAllValues(void) = 0;
86 virtual void copyValue(int to, int from) = 0;
87 virtual SbBool readValue(SoInput * in);
88 virtual SbBool read1Value(SoInput * in, int idx) = 0;
89 virtual void writeValue(SoOutput * out) const;
90 virtual void write1Value(SoOutput * out, int idx) const = 0;
91 virtual SbBool readBinaryValues(SoInput * in, int num);
92 virtual void writeBinaryValues(SoOutput * out) const;
93 virtual int getNumValuesPerLine(void) const;
94
95 static SoType classTypeId;
96 int changedIndex, numChangedIndices;
97};
98
99// inline methods
100
101inline int
102SoMField::getNum(void) const
103{
104 this->evaluate();
105 return this->num;
106}
107
108#endif // !COIN_SOMFIELD_H
SbString
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
SoBase
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition SoBase.h:45
SoField::readValue
virtual SbBool readValue(SoInput *in)=0
SoField::evaluate
void evaluate(void) const
Definition SoField.h:140
SoField::getClassTypeId
static SoType getClassTypeId(void)
Definition SoField.cpp:727
SoField::initClass
static void initClass(void)
Definition SoField.cpp:627
SoField::SoField
SoField(void)
Definition SoField.cpp:539
SoField::writeValue
virtual void writeValue(SoOutput *out) const =0
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoMField::deleteValues
virtual void deleteValues(int start, int num=-1)
Definition SoMField.cpp:679
SoMField::set1
SbBool set1(const int index, const char *const valuestring)
Definition SoMField.cpp:369
SoMField::getNum
int getNum(void) const
Definition SoMField.h:102
SoMField::enableDeleteValues
virtual void enableDeleteValues(void)
Definition SoMField.cpp:726
SoMField::SoMField
SoMField(void)
Definition SoMField.cpp:335
SoMField::isDeleteValuesEnabled
virtual SbBool isDeleteValuesEnabled(void) const
Definition SoMField.cpp:744
SoMField::userDataIsUsed
SbBool userDataIsUsed
Definition SoMField.h:82
SoMField::insertSpace
virtual void insertSpace(int start, int num)
Definition SoMField.cpp:755
SoMField::maxNum
int maxNum
Definition SoMField.h:81
SoMField::makeRoom
virtual void makeRoom(int newnum)
Definition SoMField.cpp:353
SoMField::get1
void get1(const int index, SbString &valuestring)
Definition SoMField.cpp:412
SoMField::setNum
void setNum(const int num)
Definition SoMField.cpp:645
SoMField::num
int num
Definition SoMField.h:80
SoNotRec
The SoNotRec class specifies records for notification lists.
Definition SoNotRec.h:42
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition SoOutput.h:51
SoType
The SoType class is the basis for the runtime type system in Coin.
Definition SoType.h:59