File: SoNormalBundle.h

package info (click to toggle)
inventor 2.1.5-10%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 35,712 kB
  • sloc: ansic: 33,864; lisp: 7,361; cpp: 3,874; yacc: 369; sh: 360; perl: 234; awk: 141; makefile: 80; csh: 35; sed: 11
file content (173 lines) | stat: -rw-r--r-- 6,381 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */

//  -*- C++ -*-

/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |	This file defines the SoNormalBundle class.
 |
 |   Author(s)		: Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_NORMAL_BUNDLE
#define  _SO_NORMAL_BUNDLE

#include <Inventor/bundles/SoBundle.h>
#include <Inventor/elements/SoGLNormalElement.h>
#include <Inventor/misc/SoNormalGenerator.h>

//////////////////////////////////////////////////////////////////////////////
//
//  Class: SoNormalBundle
//
//  Bundle that allows shapes to deal with normals and normal bindings
//  more easily. This class provides a fairly simple interface to
//  normal handling, including normal generation.
//
//  This class can be used during either rendering or primitive
//  generation. For primitive generation, the get() method can be used
//  to access normals. For GL rendering, the send() method can be used
//  to send normals to GL.
//
//////////////////////////////////////////////////////////////////////////////

SoEXTENDER class SoNormalBundle : public SoBundle {

  public:
    // Constructor - takes the action the bundle is used for and a
    // flag to indicate whether the bundle is being used for
    // rendering. If this is TRUE, the bundle can be used to send
    // normals to GL. 
    SoNormalBundle(SoAction *action, SbBool forRendering);

    // Destructor
    ~SoNormalBundle();

    // Returns TRUE if normals need to be generated.
    SbBool		shouldGenerate(int numNeeded);

    // Initializes generation in the case where shouldGenerate() is
    // not called. (shouldGenerate() does this automatically).
    void		initGenerator(int initialNum = 100);

    //////////////////////
    //
    // If shouldGenerate() returns TRUE, these methods can be used by
    // shapes to specify the geometry to generate normals for. They
    // are front-ends to methods on the SoNormalGenerator class:
    //

    // Send a polygon's worth of vertices. Begin a polygon, send as
    // many vertices as you want, and then end the polygon.
    void		beginPolygon()
	{ generator->beginPolygon(); }
    void		polygonVertex(const SbVec3f &point)
	{ generator->polygonVertex(point); }
    void		endPolygon()
	{ generator->endPolygon(); }

    // Send a triangle
    void		triangle(const SbVec3f &p1,
				 const SbVec3f &p2,
				 const SbVec3f &p3)
	{ generator->triangle(p1, p2, p3); }

    // Calculates the normals once all vertices have been sent. The
    // normals are stored by the bundle so the caller does not have to
    // deal with them directly.  The startIndex argument specifies the
    // index at which the generated normals will begin-- it can be
    // used by shapes that allow the coordinates and normals to be
    // offset (non-indexed shapes).  If addToState is TRUE, the
    // state will be pushed, the normals will be added to the
    // state; otherwise, you can just use
    // getGeneratedNormals/getNumGeneratedNormals to get the generated
    // normals.
    //
    // The normal bundle DOES NOT FREE the generated normals!  It is
    // expected that normals will be added to a normal cache, and the
    // normal cache will free the normals.
    //
    void		generate(int startIndex = 0,
				 SbBool addToState=TRUE);

    // Returns the generated normals.
    const SbVec3f *	getGeneratedNormals() const
	{ return generator->getNormals(); }
    int			getNumGeneratedNormals() const
	{ return generator->getNumNormals(); }


    // This allows shapes that generate their own normals (for
    // efficiency) to store the resulting normals in the state. The
    // bundle takes care of pushing/popping the state.
    // Note:  This method only adds the normals to the state, it does
    // NOT store a pointer to them (so you cannot call the
    // getGenerated() routines)
    void		set(int32_t numNormals, const SbVec3f *normals);

    // Returns indexed normal. This can be used for primitive
    // generation or during rendering
    const SbVec3f &	get(int index) const	{ return normElt->get(index); }

    // Sends indexed normal to the GL, for use only during GL rendering
    void		send(int index) const	{ GLNormElt->send(index); }

  SoINTERNAL public:
    SoNormalGenerator	*generator;	// Normal generator

  private:
    // Normal elements:
    const SoNormalElement	*normElt;
    const SoGLNormalElement	*GLNormElt;

    SbBool		isRendering;	// Bundle being used for rendering
    SbBool		pushedState;	// We pushed state to set normals
    SoNode		*currentNode;	// Node that created the bundle
};

#endif /* _SO_NORMAL_BUNDLE */