Inventor/fields/SoSubField.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/


#ifndef  _SO_SUB_FIELD_
#define  _SO_SUB_FIELD_

#include <Inventor/fields/SoField.h>
#include <Inventor/SoInput.h>
#include <Inventor/SoOutput.h>
#include <Inventor/errors/SoMemoryError.h>

//===========================================================================
//
// These are all internal macros used by some of the public ones.
//
//===========================================================================

#define SO__FIELD_HEADER(className) \
  public: \
 \
    virtual SoType getTypeId() const; \
 \
    static SoType getClassTypeId(); \
\
 \
    const className & operator =(const className &f); \
\
 private:\
    /* Copy from another field of unknown type (assumed to be same type) */ \
    virtual void copyFrom(const SoField &f); \
\
    static void * createInstance(SoType* dynamicType = NULL);  \
\
    /* Returns TRUE if fields are same type and have same values */ \
    virtual SbBool isSame(const SoField &f) const; \
\
  private: \
    static  SoType classTypeId

#define SO__SFIELD_RW_HEADER(className) \
  private: \
    /* Reads value of field from file */ \
    virtual SbBool readValue(SoInput *in); \
\
    /* Writes value of field to file */ \
    virtual void writeValue(SoOutput *out) const

#define SO__MFIELD_RW_HEADER(className) \
  private: \
    /* Reads indexed value of field from file */ \
    virtual SbBool read1Value(SoInput *in, int index); \
\
    /* Writes one (indexed) value to file */ \
    virtual void write1Value(SoOutput *out, int index) const

#if defined(_DEBUG)
#define SO_FIELD_INIT_CLASS_CHECK_PARENT(className, parentClass)                   \
  if (parentClass::getClassTypeId().isBad()) {                                        \
    SoDebugError::post( SO__QUOTE(className)"::initClass",                            \
      SO__QUOTE(className)" initialized before parent class " \
      SO__QUOTE(parentClass)"\n");                                                    \
    parentClass::initClass();                                                         \
  }
#else
#define SO_FIELD_INIT_CLASS_CHECK_PARENT(className, parentClass)                   \
  if (parentClass::getClassTypeId().isBad())                                          \
    parentClass::initClass()
#endif

#define SO__FIELD_INIT_CLASS_INTERNAL(className,classPrintName,parentClass) \
  SO_FIELD_INIT_CLASS_CHECK_PARENT(className, parentClass); \
  classTypeId = SoType::createType(parentClass::getClassTypeId(), \
                                   classPrintName, \
                                   &className::createInstance)

#define SO__FIELD_INIT_CLASS(className,classPrintName,parentClass) \
  SO__FIELD_INIT_CLASS_INTERNAL(className,classPrintName,parentClass);

#define SO__FIELD_INIT_ABSTRACT_CLASS_INTERNAL(className,classPrintName,parentClass) \
  SO_FIELD_INIT_CLASS_CHECK_PARENT(className, parentClass);                                           \
  classTypeId = SoType::createType(parentClass::getClassTypeId(),       \
                                   classPrintName,                      \
                                   NULL)

#define SO__FIELD_INIT_ABSTRACT_CLASS(className,classPrintName,parentClass) \
  SO__FIELD_INIT_ABSTRACT_CLASS_INTERNAL(className,classPrintName,parentClass);

#if defined(_DEBUG)
#define SO__FIELD_EXIT_CLASS(className) { \
  if (! SoType::removeType(classTypeId.getName())) { \
    SoDebugError::post(SO__QUOTE(className)"::exitClass", \
                       "Unable to remove type (%s) for this class. Check exitClass() " \
                       "method is implemented and is called only once.\n", \
                       classTypeId.getName().getString() ); \
  } \
  else \
    classTypeId = SoType::badType(); \
}
#else
#define SO__FIELD_EXIT_CLASS(className) \
  SoType::removeType(classTypeId.getName()); \
  classTypeId = SoType::badType()
#endif

#define SO__FIELD_ID_ABSTRACT_SOURCE(className) \
                                                \
  SoType className::classTypeId;                \
                                                \
  SoType                                        \
  className::getClassTypeId()                   \
  {                                             \
    return classTypeId;                         \
  }                                             \
                                                \
  SoType                                        \
  className::getTypeId() const                  \
  {                                             \
    return classTypeId;                         \
  }

#define SO__FIELD_ID_SOURCE(className)      \
  SO__FIELD_ID_ABSTRACT_SOURCE(className);  \
  void *                                    \
  className::createInstance(SoType *)       \
  {                                         \
    return (void *)(new className);         \
  }


#define SO__FIELD_EQ_SAME_SOURCE(className) \
\
void \
className::copyFrom(const SoField &f) \
{ \
  *this = * (const className *) &f; \
} \
\
SbBool \
className::isSame(const SoField &f) const \
{ \
  return (getTypeId() == f.getTypeId() && \
          (*this) == (const className &) f); \
}

//===========================================================================
//
// Macros to be called within the class definition header for a
// single-value field subclass:
//
//===========================================================================

//
// This declares all header info required for a single-value field class.
//

#define SO_SFIELD_REQUIRED_HEADER(className) \
  SO__FIELD_HEADER(className)

//
// This declares a constructor and destructor for a single-value field class.
//

#define SO_SFIELD_CONSTRUCTOR_HEADER(className) \
  public: \
 \
    className(); \
    \
 \
    virtual ~className()

//
// This declares value processing methods and variables for a
// single-value field class.
//

#define SO_SFIELD_VALUE_HEADER(className, valueType, valueRef) \
  SO__SFIELD_RW_HEADER(className); \
\
  public: \
 \

    valueRef getValue() const \
    { evaluate(); return value; } \
\ \

    void setValue(valueRef newValue); \
\ \
    valueRef operator =(valueRef newValue) \
    { setValue(newValue); return value; } \
\ \
    int operator ==(const className &f) const; \
\ \
    int operator !=(const className &f) const \
    { return ! ((*this) == f); } \
\ \
    virtual size_t getValueSize() const { return sizeof(valueType); } \
\
  private: \
    valueType value

//
// This is like the above macro, but can be used by a field class
// derived from another (non-abstract) field class. It will inherit
// most of the field processing stuff.
//

#define SO_SFIELD_DERIVED_VALUE_HEADER(className, valueType, valueRef) \
    SO__SFIELD_RW_HEADER(className); \
  public: \
 \
    valueRef operator =(valueRef newValue) \
    { setValue(newValue); return (valueRef)value; }

//
// This macro is all that is needed for most single-value field
// classes. It includes the relevant macros.
//

#define SO_SFIELD_HEADER(className, valueType, valueRef) \
  SO_SFIELD_REQUIRED_HEADER(className); \
  SO_SFIELD_CONSTRUCTOR_HEADER(className); \
  SO_SFIELD_VALUE_HEADER(className, valueType, valueRef)

//
// This macro is all that is needed for most single-value field
// classes that are derived from other field classes. It includes the
// relevant macros.
//

#define SO_SFIELD_DERIVED_HEADER(className, valueType, valueRef) \
  SO_SFIELD_REQUIRED_HEADER(className); \
  SO_SFIELD_CONSTRUCTOR_HEADER(className); \
  SO_SFIELD_DERIVED_VALUE_HEADER(className, valueType, valueRef)

//===========================================================================
//
// Macros to be called within the class definition header for a
// multiple-value field subclass:
//
//===========================================================================

//
// This declares all header info required for a multiple-value field class.
//

#define SO_MFIELD_REQUIRED_HEADER(className) \
  SO__FIELD_HEADER(className)

//
// This declares a constructor and destructor for a multiple-value field class.
//

#define SO_MFIELD_CONSTRUCTOR_HEADER(className) \
  public: \
 \
    className(); \
    \
 \
    virtual ~className()

//
// This declares value processing methods and variables for a
// multiple-value field class.
//

#define SO_MFIELD_VALUE_HEADER(className, valueType, valueRef) \
  SO__MFIELD_RW_HEADER(className); \
\
  public: \
 \


    valueRef operator [](int i) const \
    { evaluate(); return values[i]; } \
\ \ \ \





    const valueType *getValues(int start) const \
    { evaluate(); return const_cast<const valueType*>(static_cast<valueType *>(values + start)); } \
\ \ \ \ \
    int find(valueRef targetValue, SbBool addIfNotFound = FALSE); \
\ \ \ \ \




    void setValues(int start, int num, const valueType *newValues); \
\ \ \ \



    void set1Value(int index, valueRef newValue); \
\ \ \ \


    void setValue(valueRef newValue); \
\ \ \ \


    valueRef operator =(valueRef newValue) \
    { setValue(newValue); return newValue; } \
\ \ \ \
    int operator ==(const className &f) const; \
\ \ \ \
    int operator !=(const className &f) const \
    { return ! ((*this) == f); } \
\ \  \ \

    virtual void enableDeleteValues() \
    { setUserDataIsUsed(false); } \
\ \
    virtual void disableDeleteValues() \
    { setUserDataIsUsed(true); } \
\ \ \ \ \

    virtual SbBool isDeleteValuesEnabled() \
    { return (!getUserDataIsUsed())?TRUE:FALSE; } \
\ \
    virtual size_t getValueSize() const { return sizeof(valueType); } \
\
  private: \
    /* Allocates room for num values. Copies old values (if any) into    */ \
    /* new area.  Deletes old area, if any.  Will reduce room if needed, */ \
    /* so a value of newNum==0 will delete all values.                   */ \
    virtual void allocValues(int newNum); \
\
    /* Deletes all current values, resets number of values */ \
    virtual void deleteAllValues(); \
\
    /* Copies value indexed by "from" to value indexed by "to" */ \
    virtual void copyValue(int to, int from); \
\
    valueType *values; \
\
    /* Get pointer into array of values */ \
    virtual void* getValuesPointer(int start) \
    { return static_cast<void*>(values + start); }


//
// This is like the above macro, but can be used by a field class
// derived from another (non-abstract) field class. It will inherit
// most of the field processing stuff.
//

#define SO_MFIELD_DERIVED_VALUE_HEADER(className, valueType, valueRef) \
    SO__MFIELD_RW_HEADER(className); \
  public: \
 \
    valueRef operator =(valueRef newValue) \
    { setValue(newValue); return newValue; }

#define SO_FIELD_SUPPORT_MEMOBJ() \
private: \
  virtual bool isEnabledMemObj() { return true; } \
  virtual SoMemoryObject* getMemObj() { return m_memObj; } \
  virtual void setMemObj( SoMemoryObject* memObj ) { m_memObj = memObj; }


//
// This macro defines the start and finish editing methods.
//

#define SO_MFIELD_EDITING_HEADER(className, valueType) \
 \
 \
 \
 \
 \
 \
 \


  valueType *startEditing() { \
    evaluate(); \
    return values; \
  } \
\ \
  void finishEditing() { \
    valueChanged(0, getNum()); \
  }

//
// This macro is all that is needed for most multiple-value field
// classes. It includes the relevant macros.
//

#define SO_MFIELD_HEADER(className, valueType, valueRef) \
  SO_MFIELD_REQUIRED_HEADER(className); \
  SO_MFIELD_CONSTRUCTOR_HEADER(className); \
  SO_MFIELD_EDITING_HEADER(className, valueType); \
  SO_MFIELD_VALUE_HEADER(className, valueType, valueRef)

//
// This macro is all that is needed for most multiple-value field
// classes that are derived from other field classes. It includes the
// relevant macros.
//

#define SO_MFIELD_DERIVED_HEADER(className, valueType, valueRef) \
  SO_MFIELD_REQUIRED_HEADER(className); \
  SO_MFIELD_CONSTRUCTOR_HEADER(className); \
  SO_MFIELD_DERIVED_VALUE_HEADER(className, valueType, valueRef)

//===========================================================================
//
// Macros to be called within the source file for a single-value field
// subclass:
//
//===========================================================================

//
// This initializes type identifer variables. It should be called from
// within initClass().
//

#define SO_SFIELD_INIT_CLASS(className,parentClass) \
  SO__FIELD_INIT_CLASS(className, SO__QUOTE(className), parentClass);

#define SO_SFIELD_EXIT_CLASS(className) \
  SO__FIELD_EXIT_CLASS(className)

//
// This defines the variables and methods declared in
// SO_SFIELD_REQUIRED_HEADER().
//

#define SO_SFIELD_REQUIRED_SOURCE(className) \
\
  SO__FIELD_ID_SOURCE(className)/*;*/ \
  SO__FIELD_EQ_SAME_SOURCE(className) \
\
const className & \
className::operator =(const className &f) \
{ \
  setValue(f.getValue()); \
  return *this; \
}

#if defined(_DEBUG)
#define SO_FIELD_CHECK_INIT(className) { \
  if (classTypeId.isBad()) { \
    SoDebugError::post("Field Constructor", \
                       "Can't construct a field of type " \
                       SO__QUOTE(className) \
                       " until initClass() has been called"); \
    className::initClass(); \
  } \
  SoTypedObject::checkDatabase(SO__QUOTE(className), this, className::getClassTypeId(), classTypeId); \
}
#else
#define SO_FIELD_CHECK_INIT(className) { \
  if (classTypeId.isBad()) { \
    className::initClass(); \
  } \
}
#endif

//
// This defines the constructor and destructor.
//

#define SO_SFIELD_CONSTRUCTOR_SOURCE(className) \
\
className::className() \
{ \
  SO_FIELD_CHECK_INIT(className) \
} \
className::~className() \
{ \
}

//
// This defines the variables and methods declared in
// SO_SFIELD_VALUE_HEADER().
//

#define SO_SFIELD_VALUE_SOURCE(className, valueType, valueRef) \
\
void \
className::setValue(valueRef newValue) \
{ \
  /*If container is NULL, we are doing the first init, so don't check for equality */ \
  /*because value has never been initialized */               \
  if ( getSameValueNotificationEnabled() || getContainer() == NULL || !(value==newValue) ) \
  { \
    value = newValue; \
    valueChanged(); \
  } \
} \
\
int \
className::operator ==(const className &f) const \
{ \
  return getValue() == f.getValue(); \
}

//
// This macro is all that is needed for most single-value field
// classes. It includes the relevant macros.
//

#define SO_SFIELD_SOURCE(className, valueType, valueRef) \
  SO_SFIELD_REQUIRED_SOURCE(className)/*;*/ \
  SO_SFIELD_CONSTRUCTOR_SOURCE(className)/*;*/ \
  SO_SFIELD_VALUE_SOURCE(className, valueType, valueRef)

//
// This macro is all that is needed for most single-value field
// classes that are derived from other field classes. It includes the
// relevant macros.
//

#define SO_SFIELD_DERIVED_SOURCE(className, valueType, valueRef) \
  SO_SFIELD_REQUIRED_SOURCE(className)/*;*/ \
  SO_SFIELD_CONSTRUCTOR_SOURCE(className)

//===========================================================================
//
// Macros to be called within the source file for a multiple-value field
// subclass:
//
//===========================================================================

//
// This initializes type identifer variables. It should be called from
// within initClass().
//

#define SO_MFIELD_INIT_CLASS(className,parentClass) \
  SO__FIELD_INIT_CLASS(className, SO__QUOTE(className), parentClass);

#define SO_MFIELD_EXIT_CLASS(className) \
  SO__FIELD_EXIT_CLASS(className)

//
// This defines the variables and methods declared in
// SO_MFIELD_REQUIRED_HEADER().
//

#define SO_MFIELD_REQUIRED_SOURCE(className) \
\
  SO__FIELD_ID_SOURCE(className) \
  SO__FIELD_EQ_SAME_SOURCE(className) \
\
const className & \
className::operator =(const className &f) \
{ \
  if (f.getNum() < getNum()) \
   deleteAllValues(); \
  setValues(0, f.getNum(), f.getValues(0)); \
  return *this; \
}

//
// This defines a constructor and destructor that work with the
// variables and methods defined in SO_MFIELD_VALUE_HEADER(). If you
// define your own value processing differently, you may not be able
// to use these.
//

#define SO_MFIELD_CONSTRUCTOR_SOURCE(className) \
\
className::className() \
{ \
  SO_FIELD_CHECK_INIT(className) \
  values = NULL; \
  resetChangedStatus (); \
  m_memObj = NULL; \
} \
\
className::~className() \
{ \
    deleteAllValues(); \
\
}

//
// This defines an empty constructor and destructor for classes
// derived from other field classes, since they inherit value
// processing.
//

#define SO_MFIELD_DERIVED_CONSTRUCTOR_SOURCE(className) \
\
className::className() \
{ \
  SO_FIELD_CHECK_INIT(className) \
  resetChangedStatus (); \
} \
\
className::~className() \
{ \
}

//
// This defines the variables and methods declared in
// SO_MFIELD_VALUE_HEADER().
//

#define SO_MFIELD_VALUE_SOURCE(className, valueType, valueRef) \
\
int \
className::find(valueRef targetValue, SbBool addIfNotFound) \
{ \
  int i, myNum = getNum(); \
\
  if (values) { \
    for (i = 0; i < myNum; i++) \
      if (values[i] == targetValue) \
        return i; \
  } \
\
  if (addIfNotFound) \
    set1Value(myNum, targetValue); \
\
  return -1; \
} \
\
void \
className::setValues(int start, int myNum, const valueType *newValues) \
{ \
  int newNum = start + myNum, i; \
\
  if (newNum > getNum()) \
    makeRoom(newNum); \
\
  if (values) { \
    for (i = 0; i < myNum; i++) \
      values[start + i] = newValues[i]; \
\
    valueChanged(start, myNum); \
  } \
} \
\
void \
className::set1Value(int index, valueRef newValue) \
{ \
  if (index >= getNum()) \
    makeRoom(index + 1); \
  if (values) { \
    values[index] = newValue; \
    valueChanged(index, 1); \
  } \
} \
\
void \
className::setValue(valueRef newValue) \
{ \
  makeRoom(1); \
  if (values) { \
    values[0] = newValue; \
    valueChanged(0,1); \
  } \
} \
\
int \
className::operator ==(const className &f) const \
{ \
  int i, myNum = getNum(); \
  const valueType *myVals, *itsVals; \
\
  if (myNum != f.getNum()) \
    return FALSE; \
\
  myVals  = getValues(0); \
  itsVals = f.getValues(0); \
\
  for (i = 0; i < myNum; i++) \
    if (! (myVals[i] == itsVals[i])) \
      return FALSE; \
\
  return TRUE; \
} \
\
void \
className::deleteAllValues() \
{ \
    allocValues(0); \
} \
\
void \
className::copyValue(int to, int from) \
{ \
    values[to] = values[from]; \
}

//
// This allocates/reallocates room for values, using the "new" and
// "delete" operators, so the constructor and destructor are called
// for new and deleted values.
//

#define SO_MFIELD_ALLOC_SOURCE(className, valueType) \
void \
className::allocValues(int newNum) \
{ \
  if (values == NULL) { \
    if (newNum > 0) { \
      values = new valueType[newNum]; \
      if (values == NULL) { \
        SoMemoryError::post( "SO_MFIELD_ALLOC_SOURCE: Cannot allocate memory for the fields!" ); \
        newNum = 0; \
      } \
    } \
  } \
  else { \
    valueType *oldValues = values; \
    int i; \
\
    if (newNum > 0) { \
      values = new valueType[newNum]; \
      if (values == NULL) { \
        SoMemoryError::post( "SO_MFIELD_ALLOC_SOURCE: Cannot allocate memory for the fields!" ); \
        newNum = num; \
      } \
      else { \
        for (i = 0; i < num && i < newNum; i++) \
          values[i] = oldValues[i]; \
        delete [] oldValues; \
      } \
    } \
    else { \
      values = NULL; \
      delete [] oldValues; \
    } \
  } \
\
  num = newNum; \
}

//
// This allocates/reallocates room for values, using malloc() and
// realloc(). This means that constructors and destructors will NOT be
// called for values. Therefore, this macro should not be used for any
// value types that have constructors or destructors! (It is used for
// fields that have simple types, like shorts and floats.)
//
// It's not clear why realloc won't work in the "newNum == 1" case, but
// we definitely need to save that last value before freeing the memory!
//

#define SO_MFIELD_MALLOC_SOURCE(className, valueType) \
void \
className::allocValues(int newNum) \
{ \
  void *before = (void *)values; \
\
  if (values == NULL) { \
    if (newNum > 0) { \
      values = static_cast<valueType*>(malloc(sizeof(valueType) * newNum)); \
      if (values == NULL) { \
        SoMemoryError::post( "SO_MFIELD_MALLOC_SOURCE: Cannot allocate memory for the fields!" ); \
        newNum = 0; \
      } \
    } \
  } \
  else { \
    /* Jerome Lague BEGIN ADDED on 7/03/06*/ \
    /* Special case when user calls setValue(newValue) to reset field */ \
    /* Necessary to wrap the setValuesPointer method in .NET */ \
    if (newNum == 1) {\
      valueType value0 = *(static_cast<valueType*>(values)); /* Save last value */ \
      if (isDeleteValuesEnabled()) \
        free((char *) values);\
      values = (valueType *) malloc(sizeof(valueType)); \
      if (values == NULL) { \
        SoMemoryError::post( "SO_MFIELD_MALLOC_SOURCE: Cannot allocate memory for the fields!" ); \
        newNum = num; \
      } \
      else { \
        *((valueType *)values) = value0; /* Restore last value */ \
        setUserDataIsUsed(false);\
      } \
    } \
    /* Jerome Lague END ADDED on 7/03/06*/ \
    else if (newNum > 1) { \
      void *after = NULL; \
      if (getUserDataIsUsed() == false) { \
        after = realloc(values, sizeof(valueType) * newNum); \
      } else { \
        /* if user data is used, allocates a new buffer and copy data into without deleting the user buffer. */ \
        after = malloc(sizeof(valueType) * newNum); \
        if ( after ) \
          memcpy(after, before, sizeof(valueType) * (num < newNum ? num : newNum) ); \
      } \
      if (after == NULL) { \
        SoMemoryError::post( "SO_MFIELD_MALLOC_SOURCE: Cannot allocate memory for the fields!" ); \
        newNum = num; \
      } \
      else \
        values = (valueType *)after; \
    } \
    else { \
      if (getUserDataIsUsed() == false) { \
        free((char *)values); \
      } \
      values = NULL; \
    } \
  } \
  num = newNum; \
\
  if (before != (void *)values) { \
    setUserDataIsUsed(false); \
  } \
}

//
// This macro is all that is needed for most multiple-value field
// classes. It includes the relevant macros, including the allocation
// macro that uses new and delete.
//

#define SO_MFIELD_SOURCE(className, valueType, valueRef) \
  SO_MFIELD_REQUIRED_SOURCE(className) \
  SO_MFIELD_CONSTRUCTOR_SOURCE(className) \
  SO_MFIELD_VALUE_SOURCE(className, valueType, valueRef) \
  SO_MFIELD_ALLOC_SOURCE(className, valueType)

//
// This is like the above macro, but uses the allocation macro that
// uses malloc() and realloc().
//

#define SO_MFIELD_SOURCE_MALLOC(className, valueType, valueRef) \
  SO_MFIELD_REQUIRED_SOURCE(className) \
  SO_MFIELD_CONSTRUCTOR_SOURCE(className) \
  SO_MFIELD_VALUE_SOURCE(className, valueType, valueRef) \
  SO_MFIELD_MALLOC_SOURCE(className, valueType)

//
// This macro is all that is needed for most multiple-value field
// classes that are derived from other field classes. It includes the
// relevant macros.
//

#define SO_MFIELD_DERIVED_SOURCE(className, valueType, valueRef) \
  SO_MFIELD_REQUIRED_SOURCE(className); \
  SO_MFIELD_DERIVED_CONSTRUCTOR_SOURCE(className)


//
//  This declares header info required for setValues using user data.
//

#define SO_MFIELD_SETVALUESPOINTER_HEADER(userType) \
public: \
 \
 \
 \
 \
 \
 \
 \
 \
 \
 \
 \
 \
 \




  void setValuesPointer(int num, const userType *userData); \
\ \

  void setValuesPointer(int num, userType *userData) 




//
//  This macro defines setValues method using user data
//  Data will not be duplicated into the field.
//

#include <Inventor/errors/SoDebugError.h>
#define SO_MFIELD_SETVALUESPOINTER_SOURCE(className, valueType, userType) \
void \
className::setValuesPointer(int myNum, const userType *userData) \
{ \
  if (myNum > 0 && userData != NULL) { \
    if ( getUserDataIsUsed() && userData == (const userType*)values ) { \
    } \
    else if (getNum() > 0) { \
      makeRoom(0); \
    } \
    values = (valueType *)userData; \
    setUserDataIsUsed(true); \
    num = myNum; \
    valueChanged(0, num); \
  } \
} \
\
void \
className::setValuesPointer(int myNum, userType *userData) \
{ \
  setValuesPointer(myNum, (const userType *)userData); \
}

#endif /* _SO_SUB_FIELD_ */

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/