Inventor/nodes/SoPattern.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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : P. ESTRADE (Nov 1999)
**=======================================================================*/
#pragma once

#include <Inventor/fields/SoSFString.h>
#include <Inventor/fields/SoSFBool.h>

#include <Inventor/nodes/SoNode.h>

#include <Inventor/SbPImpl.h>

class SoGLRenderAction;
class SoCallbackAction;

SO_PIMPL_PUBLIC_DECLARATION( SoPattern )
class  SoPattern : public SoNode {

  SO_NODE_HEADER( SoPattern );
  SO_PIMPL_PUBLIC_HEADER( SoPattern )

 public:
  SoSFString category;
  SoSFString name;

  SoPattern();

  enum FilterType {
    INCLUSIVE_FILTER,
    EXCLUSIVE_FILTER
  };

  SoNONUNICODE static SbBool loadPatterns( const char* fileName, int numFilters = 0, 
                              const SbString* filterNames = NULL,
                              FilterType filterType = INCLUSIVE_FILTER );

  static SbBool loadPatterns( const SbString& fileName, int numFilters = 0, 
                              const SbString* filterNames = NULL,
                              FilterType filterType = INCLUSIVE_FILTER );

  static void  getPatternNames( int& number, SbString*& names,
                                const char* category = NULL );

  SoNONUNICODE static void addPattern( const char* category, const char* name,
                          const unsigned char* bytes );

  static void addPattern( const SbString& category, const SbString& name,
                          const unsigned char* bytes );

  SoNONUNICODE static void getPattern( const char* category, const char* name, unsigned char*& bytes );

  static void getPattern( const SbString& category, const SbString& name, unsigned char*& bytes );

  inline virtual void setOverride(const SbBool state)
  { override.setValue(state); }

  inline virtual SbBool isOverride() const
  { return override.getValue(); }

 private:
  virtual void doAction( SoAction *action );
  virtual void callback( SoCallbackAction *action );
  virtual void GLRender( SoGLRenderAction *action );

  //------------------------------------------------------------------------------

 private:
  static void initClass();
  static void exitClass();

  SoSFBool override;

 private:
  // Destructor
  virtual ~SoPattern();
};
//--------------------------------------------------------------------------------

---

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/