Developer Documentation

GridNode.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
43
44
45
46
47 //=============================================================================
48 //
49 // CLASS GridNode
50 //
51 //=============================================================================
52
53
54 #ifndef ACG_GRIDNODE_HH
55 #define ACG_GRIDNODE_HH
56
57
58 //== INCLUDES =================================================================
59
60
61 #include "MaterialNode.hh"
62 #include <vector>
63
64
65 //== NAMESPACES ===============================================================
66
67
68 namespace ACG {
69 namespace SceneGraph {
70
71
72 //== CLASS DEFINITION =========================================================
73
74
75
82 class ACGDLLEXPORT GridNode : public MaterialNode
83 {
84 public:
85
87 GridNode(BaseNode* _parent=0,
88 const std::string& _name="<GridNode>" );
89
91 ~GridNode() {}
92
94 enum Orientation { NONE = 0,
95 XY_PLANE = 1 ,
96 XZ_PLANE = 2 ,
97 YZ_PLANE = 4 };
98
100 ACG_CLASSNAME(GridNode);
101
103 ACG::SceneGraph::DrawModes::DrawMode availableDrawModes() const override;
104
106 void boundingBox(Vec3d& _bbMin, Vec3d& _bbMax) override;
107
109 void draw(GLState& _state, const DrawModes::DrawMode& _drawMode) override;
110
112 void pick(GLState& _state, PickTarget _target) override;
113
114 public:
115
117 float gridSize();
118
120 void gridSize(float _size);
121
122
128 void minRefinementDistance( double _distance );
129
132 double minRefinementDistance();
133
137 void setOrientation( unsigned int _orientation ) ;
138
139 void autoResize(bool _auto);
140
141 private:
142
144 int horizontalLines_;
145 int verticalLines_;
146 int maxRefinement_;
147
148
152 double minRefinementDistance_;
153
155 float gridSize_;
156
158 Vec3d bb_min_;
159 Vec3d bb_max_;
160
162 Vec3f baseLineColor_;
163 Vec3f midLineColor_;
164
165 bool autoResize_;
166
168 unsigned int orientation_;
169
170 };
171
172
173 //=============================================================================
174 } // namespace SceneGraph
175 } // namespace ACG
176 //=============================================================================
177 #endif // ACG_GRIDNODE_HH defined
178 //=============================================================================
179
ACG::SceneGraph::GridNode::minRefinementDistance_
double minRefinementDistance_
Definition: GridNode.hh:152
ACG::SceneGraph::GridNode::baseLineColor_
Vec3f baseLineColor_
colors for the grid
Definition: GridNode.hh:162
ACG::GLState
Definition: GLState.hh:213
ACG
Namespace providing different geometric functions concerning angles.
Definition: BaseObjectData.hh:68
OpenMesh::VectorT
Definition: Vector11T.hh:83
ACG::SceneGraph::MaterialNode
Definition: MaterialNode.hh:338
ACG::SceneGraph::GridNode::bb_min_
Vec3d bb_min_
bounding box
Definition: GridNode.hh:158
SceneGraph
Definition: QtPrincipalAxisDialog.hh:67
ACG::SceneGraph::PickTarget
PickTarget
What target to use for picking.
Definition: PickTarget.hh:73
ACG::SceneGraph::GridNode::~GridNode
~GridNode()
Destructor.
Definition: GridNode.hh:91
ACG::SceneGraph::BaseNode
Definition: BaseNode.hh:104
ACG::SceneGraph::GridNode::Orientation
Orientation
Enum for Orientation.
Definition: GridNode.hh:94
ACG::SceneGraph::GridNode::orientation_
unsigned int orientation_
Contains all orientations to draw.
Definition: GridNode.hh:168
ACG::SceneGraph::DrawModes::DrawMode
Specifies a DrawMode.
Definition: DrawModes.hh:288
ACG::SceneGraph::GridNode
Definition: GridNode.hh:82
ACG::SceneGraph::GridNode::horizontalLines_
int horizontalLines_
initial number of baseLines
Definition: GridNode.hh:144
ACG::SceneGraph::GridNode::gridSize_
float gridSize_
dimensions of the grid
Definition: GridNode.hh:155