SoMFColor.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)
**=======================================================================*/
/*=======================================================================
 *** 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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_MF_COLOR_
#define  _SO_MF_COLOR_
 
#include <Inventor/fields/SoSubField.h>
#include <Inventor/SbColor.h>
#include <Inventor/fields/SoMFVec3f.h>
 
//
//  SoMFColor subclass of SoMField.
//
 
class  SoMFColor : public SoMField {
  // Use standard field stuff
  SO_MFIELD_HEADER(SoMFColor, SbColor, const SbColor &);
  
  SO_MFIELD_SETVALUESPOINTER_HEADER(float);
  SO_FIELD_SUPPORT_MEMOBJ();
public:
  //
  // Additional convenience functions
  //
  
  void setValues(int start, int num, const float rgb[][3]);
  void setHSVValues(int start, int num, const float hsv[][3]);
  
  void setValue(const SbVec3f &vec);
  void setValue(float r, float g, float b);
  void setValue(const float rgb[3]);
  
  void setHSVValue(float h, float s, float v);
  void setHSVValue(const float hsv[3]);
  
  void set1Value(int index, const SbVec3f &vec);
  void set1Value(int index, float r, float g, float b);
  void set1Value(int index, const float rgb[3]);
  
  void set1HSVValue(int index, float h, float s, float v);
  void set1HSVValue(int index, const float hsv[3]);
  
 private:
  static void initClass();
  static void exitClass();
  virtual void writeBinaryValues(SoOutput*, int , int ) const;
  virtual SbBool readBinaryValues( SoInput*, int, int );
 
 private:
  virtual void writeBinaryValues(SoOutput *out) const;
  virtual SbBool readBinaryValues(SoInput *in, int numToRead);
 
  //
  // #unfound setValues(int start, int num, float rgb[][3])
  // #unfound setHSVValues(int start, int num, float hsv[][3])
  // #unfound setValue(SbVec3f & vec)
  // #unfound setValue(float red, float green, float blue)
  // #unfound setHSVValue(float hue, float saturation, float value)
  // #unfound setValue(float rgb[3])
  // #unfound setHSVValue(float hsv[3])
  // #unfound set1Value(index , SbVec3f & vec)
  // #unfound set1Value(index , float r, float g, float b)
  // #unfound set1HSVValue(index , float h, float s, float v)
  // #unfound set1Value(index , float rgb[3])
  // #unfound set1HSVValue(index , float hsv[3])
  // #unfound [](int i)
  // #unfound getValues(int start)
  // #unfound find(SbColor & targetValue, SbBool addIfNotFound)
  // #unfound setValues(int start, int num, SbColor * newValues)
  // #unfound set1Value(int index, SbColor & newValue)
  // #unfound =(SbColor & newValue)
  // #unfound setValue(SbColor & newValue)
  // #unfound ==(SoMFColor & f)
  // #unfound !=(SoMFColor & f)
  // #unfound startEditing()
  // #unfound finishEditing()
  // #unfound setValuesPointer(int num, SbColor * data)
  // #unfound enableDeleteValues()
  // #unfound isDeleteValuesEnabled()
  // #grouped setHSVValues(int start, int num, float hsv[][3])
  // #grouped setValue(float red, float green, float blue)
  // #grouped setHSVValue(float hue, float saturation, float value)
  // #grouped setValue(float rgb[3])
  // #grouped setHSVValue(float hsv[3])
  // #grouped set1Value(index , float r, float g, float b)
  // #grouped set1HSVValue(index , float h, float s, float v)
  // #grouped set1Value(index , float rgb[3])
  // #grouped set1HSVValue(index , float hsv[3])
  // #grouped getTypeId()
  // #grouped setValue(SbColor & newValue)
  // #grouped !=(SoMFColor & f)
  // #grouped finishEditing()
  // #grouped isDeleteValuesEnabled()
  //
 
};
 
#endif /* _SO_MF_COLOR_ */