SoMField.h

/*=======================================================================
 * 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)
** Modified by : Nick Thompson (MMM yyyy)
** Modified by : Gavin Bell (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-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_MFIELD_
#define  _SO_MFIELD_
 
#include <Inventor/fields/SoField.h>
 
//
//  Class: SoMField
//
//  Field that can have multiple values.
//
 
class  SoMField : public SoField {
 
 public:
  // Destructor
#ifndef HIDDEN_FROM_DOC
  virtual ~SoMField();
#endif // HIDDEN_FROM_DOC
 
  int getNum() const { evaluate(); return num; }
 
  void setNum(int num);
 
  virtual void deleteValues(int start, int num = -1);
 
  virtual void insertSpace(int start, int num);
 
  SoNONUNICODE SbBool set1(int index, const char *valueString);
 
 
  SbBool set1(int index, const SbString& valueString);
 
  void get1(int index, SbString &valueString);
 
  static SoType getClassTypeId();
  
 private:
  static void initClass();
  static void exitClass();
 
  static void *createInstance(SoType* dynamicType = NULL);
  
  // Data change notification
  int  getChangedStartIndex();
  int  getChangedNumValues();
  int  getChangedType();
 
  void valueChanged(int start = -1, int numValues = -1, SbBool resetDefault = TRUE);
 
  // Reads one indexed value of field from file
  virtual SbBool read1Value(SoInput *in, int index) = 0;
  
  // Writes indexed value to file
  virtual void write1Value(SoOutput *out, int index) const = 0;
 
  virtual void writeBinaryValues(SoOutput*, int , int ) const;
  virtual SbBool readBinaryValues(SoInput*, int , int );
  virtual void* getValuesPointer( int ) { return NULL; }
 
 private:
  // Constructor
  SoMField();
  
  // Make sure there is room for newNum vals
  virtual void makeRoom(int newNum);
 
  // Notified changes
  void  resetChangedStatus();
  int   changedStartIndex;
  int   changedNumValues;
 
private:
  static SoType classTypeId;
  
  // Allocates room for num values. Copies old values (if any) into
  // new area. Deletes old area, if any.
  virtual void allocValues(int num) = 0;
  
  // Deletes all current values
  virtual void deleteAllValues() = 0;
  
  // Copies value indexed by "from" to value indexed by "to"
  virtual void copyValue(int to, int from) = 0;
  
  // Reads all values of field
  virtual SbBool readValue(SoInput *in);
  
  // Writes all values of field
  virtual void writeValue(SoOutput *out) const;
  
  // Reads array of binary values from file
  virtual SbBool readBinaryValues(SoInput *in, int numToRead);
  
  // Writes array of binary values to file
  virtual void writeBinaryValues(SoOutput *out) const;
  
  // Returns number of ASCII values to write per output line (default 1)
  virtual int   getNumValuesPerLine() const;
  
private:
  SoMemoryObject* m_memObj;
};
 
#endif /* _SO_MFIELD_ */