Open Inventor Reference
SoGLMaterialIndexElement.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * Further, this software is distributed without any warranty that it is
16  * free of the rightful claim of any third person regarding infringement
17  * or the like. Any license provided herein, whether implied or
18  * otherwise, applies only to this software file. Patent licenses, if
19  * any, provided herein do not apply to combinations of this program with
20  * other software, or any other product whatsoever.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27  * Mountain View, CA 94043, or:
28  *
29  * http://www.sgi.com
30  *
31  * For further information regarding this notice, see:
32  *
33  * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34  *
35  */
36 
37 
38 /*
39  * Copyright (C) 1990,91 Silicon Graphics, Inc.
40  *
41  _______________________________________________________________________
42  ______________ S I L I C O N G R A P H I C S I N C . ____________
43  |
44  | $Revision: 1.1.1.1 $
45  |
46  | Description:
47  | This file defines the SoGLMaterialIndexElement class.
48  |
49  | Author(s) : Paul S. Strauss
50  |
51  ______________ S I L I C O N G R A P H I C S I N C . ____________
52  _______________________________________________________________________
53  */
54 
55 #ifndef _SO_GL_MATERIAL_INDEX_ELEMENT
56 #define _SO_GL_MATERIAL_INDEX_ELEMENT
57 
59 
74 
76 
78 
79  public:
81  virtual void init(SoState *state);
82 
86  static void set(SoState *state, SoNode *node,
87  int32_t numIndices,
88  const int32_t *ambientIndices,
89  const int32_t *diffuseIndices,
90  const int32_t *specularIndices);
91 
94 
96  int32_t getNum() const { return numIndices; }
97 
99  int32_t getAmbient(int index) const;
100  int32_t getDiffuse(int index) const;
101  int32_t getSpecular(int index) const;
102 
104  static int32_t getDefaultAmbient() { return 1; }
105  static int32_t getDefaultDiffuse() { return 2; }
106  static int32_t getDefaultSpecular() { return 3; }
107 
109  virtual void push(SoState *state);
110  virtual void pop(SoState *state, const SoElement *prevTopElement);
111 
114  virtual SbBool matches(const SoElement *elt) const;
115 
117  virtual SoElement *copyMatchInfo() const;
118 
120  virtual void print(FILE *fp) const;
121 
123  void send(int index) const;
124 
125  SoINTERNAL public:
127  static void initClass();
128 
129  protected:
131  const int32_t *ambientIndices, *diffuseIndices, *specularIndices;
132 
134 
135  private:
139  static int32_t defaultAmbientIndex;
140  static int32_t defaultDiffuseIndex;
141  static int32_t defaultSpecularIndex;
142 
145  int lastIndex;
146 };
147 
148 #endif /* _SO_GL_MATERIAL_INDEX_ELEMENT */
#define SoEXTENDER
Provide inline template functions for abs, swap, min, max, and clamp.
Definition: SbBasic.h:154
#define SoINTERNAL
Definition: SbBasic.h:155
bool SbBool
The original OIV version used SbBool as a typedef to int.
Definition: SbBasic.h:85
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
signed int int32_t
Definition: SbTypeDefs.h:43
#define SO_ELEMENT_HEADER(className)
This one is for non-abstract element classes.
Definition: SoSubElement.h:112
This is the abstract base class for all state elements.
Definition: SoElement.h:96
Element that stores the indices into the current GL material map of the ambient, diffuse,...
int32_t getSpecular(int index) const
int32_t getAmbient(int index) const
Returns the indexed indices from an element.
static void initClass()
Initializes the SoGLMaterialIndexElement class.
void send(int index) const
Sends indexed values to GL.
static void set(SoState *state, SoNode *node, int32_t numIndices, const int32_t *ambientIndices, const int32_t *diffuseIndices, const int32_t *specularIndices)
Sets the current material indices.
static const SoGLMaterialIndexElement * getInstance(SoState *state)
Returns the top (current) instance of the element in the state.
virtual void pop(SoState *state, const SoElement *prevTopElement)
virtual SoElement * copyMatchInfo() const
Create and return a copy of this element.
virtual SbBool matches(const SoElement *elt) const
Override matches() to return TRUE only if node-id's match AND last values sent to GL match.
virtual void push(SoState *state)
Override push() and pop() methods to maintain GL state.
int32_t getNum() const
Returns the number of indices in an instance.
virtual ~SoGLMaterialIndexElement()
virtual void print(FILE *fp) const
Prints element (for debugging)
virtual void init(SoState *state)
Initializes element.
static int32_t getDefaultAmbient()
Returns the default indices.
int32_t getDiffuse(int index) const
Abstract base class for all database nodes.
Definition: SoNode.h:103
This is the abstract base class for each state element whose value is replaced whenever it is set.
An SoState collects and holds state while traversing a scene graph.
Definition: SoState.h:82