File: SoModelMatrixElement.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 (182 lines) | stat: -rw-r--r-- 6,695 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
174
175
176
177
178
179
180
181
182
/*
 *
 *  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 SoModelMatrixElement class.
 |
 |   Author(s)		: Paul S. Strauss, Gavin Bell
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */

#ifndef  _SO_MODEL_MATRIX_ELEMENT
#define  _SO_MODEL_MATRIX_ELEMENT

#include <Inventor/SbLinear.h>
#include <Inventor/elements/SoAccumulatedElement.h>

//////////////////////////////////////////////////////////////////////////////
//
//  Class: SoModelMatrixElement
//
//  Element that stores the current model matrix - the cumulative
//  transformation applied to subsequent shapes. Because the matrix is
//  cumulative, this class is derived from SoAccumulatedElement. The
//  set() method replaces the current matrix, while all the others
//  (mult(), translateBy(), etc.) multiply into it. Node id's of the
//  nodes that affect the element are accumulated properly.
//
//  This element also stores the current view-volume culling
//  transformation, which is normally the view*projection matrices
//  (set by cameras), but which may be modified by sophisticated
//  culling schemes.
//
//////////////////////////////////////////////////////////////////////////////

SoEXTENDER class SoModelMatrixElement : public SoAccumulatedElement {

    SO_ELEMENT_HEADER(SoModelMatrixElement);

  public:
    // Initializes element
    virtual void	init(SoState *state);
    
    // Override standard matches to invalidate on cull-test
    virtual SbBool	matches(const SoElement *elt) const;


    // Overrides push() method to copy values from next instance in the stack
    virtual void	push(SoState *state);

    // Sets the model matrix to the identity matrix
    static void		makeIdentity(SoState *state, SoNode *node);

    // Sets the model matrix to the given matrix
    static void		set(SoState *state, SoNode *node,
			    const SbMatrix &matrix);

    // Multiplies the given matrix into the model matrix
    static void		mult(SoState *state, SoNode *node,
			     const SbMatrix &matrix);

    // Each of these multiplies a matrix that performs the specified
    // transformation into the model matrix
    static void		translateBy(SoState *state, SoNode *node,
				    const SbVec3f &translation);
    static void		rotateBy(SoState *state, SoNode *node,
				 const SbRotation &rotation);
    static void		scaleBy(SoState *state, SoNode *node,
				const SbVec3f &scaleFactor);

    // These methods are used by the TransformSeparator node.
    // WARNING!  For proper caching behavior, the matrix returned by
    // ::pushMatrix() must be used ONLY as a later argument to
    // ::popMatrix(), and you must NOT modify the matrix between the
    // push and the pop.  If you need the matrix for any other reason,
    // you MUST use the ::get() routine.
    static SbMatrix	pushMatrix(SoState *state);
    static void		popMatrix(SoState *state, const SbMatrix &m);

    // Sets the transformation that defines the volume that
    // view-volume culling should be tested against.
    static void		setCullMatrix(SoState *state, SoNode *node,
				      const SbMatrix &matrix);

    // This method gets the model*cullMatrix combined matrix (which is
    // cached by this element).
    static const SbMatrix &	getCombinedCullMatrix(SoState *state);

    // Returns current model matrix from the state
    static const SbMatrix &	get(SoState *state);

    // Returns current model matrix from the state, sets given flag to TRUE
    // if matrix is known to be identity
    static const SbMatrix &	get(SoState *state, SbBool &isIdent);

    // Prints element (for debugging)
    virtual void	print(FILE *fp) const;

  SoINTERNAL public:
    // Initializes the SoModelMatrixElement class
    static void		initClass();

  protected:
    // Sets the matrix in an instance to identity
    virtual void	makeEltIdentity();

    // Sets the matrix in an instance to given matrix
    virtual void	setElt(const SbMatrix &matrix);

    // Multiplies into the matrix in an instance
    virtual void	multElt(const SbMatrix &matrix);

    // Each of these performs the appropriate operation on the matrix
    // in an instance
    virtual void	translateEltBy(const SbVec3f &translation);
    virtual void	rotateEltBy(const SbRotation &translation);
    virtual void	scaleEltBy(const SbVec3f &scaleFactor);

    // virtual methods for push/pop so GL element can Do The Right Thing:
    virtual SbMatrix	pushMatrixElt();
    virtual void	popMatrixElt(const SbMatrix &m);

    virtual ~SoModelMatrixElement();

  private:
    SbMatrix		modelMatrix;
    SbMatrix		cullMatrix;
    SbMatrix		modelCullMatrix;
    struct {
	unsigned int 	isModelIdentity : 1;
	unsigned int	haveCullMatrix	: 1; // TRUE if cullMatrix set
	unsigned int	haveModelCull	: 1; // TRUE if model*cull computed
    } flags;

    friend class SoLocalBBoxMatrixElement;
};

#endif /* _SO_MODEL_MATRIX_ELEMENT */