SoMFInstanceParameter.h

/*=======================================================================
 *** 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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : David Beilloin (Aug 2013)
**=======================================================================*/
 
#ifndef  _SO_MF_INSTANCE_PARAMETER_
#define  _SO_MF_INSTANCE_PARAMETER_
 
#include <Inventor/fields/SoSubField.h>
#include <Inventor/nodes/SoInstanceParameter.h>
 
 
class  SoMFInstanceParameter : public SoMField {
 
  SO_MFIELD_REQUIRED_HEADER(SoMFInstanceParameter);
  SO_MFIELD_CONSTRUCTOR_HEADER(SoMFInstanceParameter);
  SO_MFIELD_VALUE_HEADER(SoMFInstanceParameter, SoInstanceParameter *, SoInstanceParameter *);
  SO_MFIELD_SETVALUESPOINTER_HEADER(SoInstanceParameter *);
 
public:
  SoInstanceParameter* findParameterByName(const SbString& name) const;
 
  SoInstanceParameter* setColors( SbColor* values,
                                  size_t nbValues,
                                  uint32_t divisor = 1,
                                  SoMemoryObject::CopyPolicy policy = SoMemoryObject::NO_COPY );
 
  SoInstanceParameter* setTransparencies( float* values,
                                          size_t nbValues,
                                          uint32_t divisor = 1,
                                          SoMemoryObject::CopyPolicy policy = SoMemoryObject::NO_COPY );
 
  SoInstanceParameter* setScales( SbVec3f* values,
                                  size_t nbValues,
                                  uint32_t divisor = 1,
                                  SoMemoryObject::CopyPolicy policy = SoMemoryObject::NO_COPY );
 
  SoInstanceParameter* setRotations( SbVec4f* values,
                                     size_t nbValues,
                                     uint32_t divisor = 1,
                                     SoMemoryObject::CopyPolicy policy = SoMemoryObject::NO_COPY );
 
  SoInstanceParameter* setRotations( SbRotation* values,
                                     size_t nbValues,
                                     uint32_t divisor = 1,
                                     SoMemoryObject::CopyPolicy policy = SoMemoryObject::NO_COPY );
 
  SoInstanceParameter* setVisibilities( int32_t* values,
                                        size_t nbValues,
                                        uint32_t divisor = 1,
                                        SoMemoryObject::CopyPolicy policy = SoMemoryObject::NO_COPY );
 
  SoInstanceParameter* setTranslations( SbVec3f* values,
                                        size_t nbValues,
                                        uint32_t divisor = 1,
                                        SoMemoryObject::CopyPolicy policy = SoMemoryObject::NO_COPY );
 
  bool removeParameterByName(const SbString& name);
 
  SoInstanceParameter** startEditing();
 
  void finishEditing();
 
  private:
  static void initClass();
  static void exitClass();
 
  // Update a copied field to use the copy of each uniform shader parameter if there is one
  virtual void fixCopy(SbBool copyConnections);
 
  // Override this to also check the stored uniform shader parameters
  virtual SbBool referencesCopy() const;
 
private:
  // Override this to maintain write-references in uniform shader parameters
  virtual void countWriteRefs(SoOutput *out) const;
 
  // Changes value in field without doing other notification stuff.
  // Keeps track of references and auditors.
  void setVal(int index, SoInstanceParameter *newValue);
 
  static bool hasGivenName(SbString name, const SoShaderParameter* param);
 
  SoInstanceParameter** m_oldValues;
  int m_oldNum;
};
 
 
#endif /* _SO_MF_INSTANCE_PARAMETER_ */