SoInstanceParameter.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2018 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : David Beilloin (Aug 2013)
**=======================================================================*/
 
 
#ifndef _SO_INSTANCE_PARAMETER_H_
#define _SO_INSTANCE_PARAMETER_H_
 
#include <Inventor/SbBasic.h>
#include <Inventor/nodes/SoNode.h>
 
#include <Inventor/nodes/SoShaderParameter.h>
 
#include <Inventor/fields/SoSFBufferObject.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFUInt32.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFEnum.h>
 
 
class  SoInstanceParameter : public SoVertexShaderParameterBufferObject
{
  SO_NODE_HEADER(SoInstanceParameter);
 
public:
 
  SoInstanceParameter();
 
  SoSFUInt32 divisor;
 
  enum PredefinedParameters
  {
    TRANSLATION = 0,
    ROTATION,
    SCALE,
    VISIBILITY,
    COLOR,
    TRANSPARENCY,
    NUM_PREDEFINED_PARAMETERS
  };
 
  static SoInstanceParameter* createPredefinedParameter( SoInstanceParameter::PredefinedParameters paramKey, 
                                                         const SoBufferObject* values, uint32_t divisor = 1 );
 
  static SbString getPredefinedParameterName( SoInstanceParameter::PredefinedParameters paramKey );
 
  void setPredefinedParameterName( SoInstanceParameter::PredefinedParameters paramKey );
 
private:
  static void initClass();
 
  static void exitClass();
 
  virtual void        notify(SoNotList *list);
 
  // Attrib divisor is set by a field
  virtual unsigned int getVertexAttribDivisor() { return divisor.getValue(); }
 
private:
  // Destructor
  virtual ~SoInstanceParameter();
 
};
 
/*----------------------------------------------------------------------------*/
 
#endif /* _SO_INSTANCE_PARAMETER_H_ */