Open Inventor Reference
SoClipPlaneElement.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 SoClipPlaneElement 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_CLIP_PLANE_ELEMENT
56 #define _SO_CLIP_PLANE_ELEMENT
57 
58 #include <Inventor/SbLinear.h>
60 
76 
78 
80 
81  public:
83  virtual void init(SoState *state);
84 
86  static void add(SoState *state, SoNode *node,
87  const SbPlane &plane);
88 
90  virtual void push(SoState *state);
91 
93  virtual void pop(SoState *state, const SoElement *prevTopElement);
94 
96  static const SoClipPlaneElement * getInstance(SoState *state);
97 
99  int getNum() const;
100 
103  const SbPlane & get(int index, bool inWorldSpace = TRUE) const;
104 
106  virtual void print(FILE *fp) const;
107 
108  SoINTERNAL public:
110  static void initClass();
111 
112  protected:
116 
119  virtual void addToElt(const SbPlane &plane,
120  const SbMatrix &modelMatrix);
121 
123 };
124 
125 #endif /* _SO_CLIP_PLANE_ELEMENT */
#define SoEXTENDER
Provide inline template functions for abs, swap, min, max, and clamp.
Definition: SbBasic.h:154
#define TRUE
Definition: SbBasic.h:76
#define SoINTERNAL
Definition: SbBasic.h:155
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
#define SO_ELEMENT_HEADER(className)
This one is for non-abstract element classes.
Definition: SoSubElement.h:112
4x4 matrix class.
Definition: SbLinear.h:823
List of generic (void *) pointers.
Definition: SbPList.h:78
Oriented plane in 3D.
Definition: SbLinear.h:1360
This is the abstract base class for each state element whose value may be accumulated when it is set.
Element that stores the current set of clipping planes, specified as SbPlanes.
int getNum() const
Returns the number of planes in an instance.
virtual void init(SoState *state)
Initializes element.
virtual void addToElt(const SbPlane &plane, const SbMatrix &modelMatrix)
Adds the clipping plane to an instance.
virtual ~SoClipPlaneElement()
static const SoClipPlaneElement * getInstance(SoState *state)
Returns the top (current) instance of the element in the state.
static void initClass()
Initializes the SoClipPlaneElement class.
virtual void print(FILE *fp) const
Prints element (for debugging)
SbPList planes
List of plane structures.
const SbPlane & get(int index, bool inWorldSpace=TRUE) const
Returns the indexed plane an element as an SbPlane.
int startIndex
Index of 1st plane created in this instance.
virtual void push(SoState *state)
Overrides push() method to copy values from next instance in the stack.
static void add(SoState *state, SoNode *node, const SbPlane &plane)
Adds a clip plane to the current set in the state.
virtual void pop(SoState *state, const SoElement *prevTopElement)
Overrides pop() method to free up planes that were added.
This is the abstract base class for all state elements.
Definition: SoElement.h:96
Abstract base class for all database nodes.
Definition: SoNode.h:103
An SoState collects and holds state while traversing a scene graph.
Definition: SoState.h:82