Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Plane.hpp
Go to the documentation of this file.
1 /**************************************************************************************/
2 /* */
3 /* Visualization Library */
4 /* http://visualizationlibrary.org */
5 /* */
6 /* Copyright (c) 2005-2017, Michele Bosi */
7 /* All rights reserved. */
8 /* */
9 /* Redistribution and use in source and binary forms, with or without modification, */
10 /* are permitted provided that the following conditions are met: */
11 /* */
12 /* - Redistributions of source code must retain the above copyright notice, this */
13 /* list of conditions and the following disclaimer. */
14 /* */
15 /* - Redistributions in binary form must reproduce the above copyright notice, this */
16 /* list of conditions and the following disclaimer in the documentation and/or */
17 /* other materials provided with the distribution. */
18 /* */
19 /* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED */
21 /* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE */
22 /* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR */
23 /* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES */
24 /* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; */
25 /* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON */
26 /* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT */
27 /* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS */
28 /* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
29 /* */
30 /**************************************************************************************/
31 
32 #ifndef Plane_INCLUDE_ONCE
33 #define Plane_INCLUDE_ONCE
34 
35 #include <vlCore/Object.hpp>
36 #include <vlCore/glsl_math.hpp>
37 #include <vlCore/Transform.hpp>
38 
39 namespace vl
40 {
41  class AABB;
42 
43  //-----------------------------------------------------------------------------
44  // Plane
45  //-----------------------------------------------------------------------------
49  class VLCORE_EXPORT Plane: public Object
50  {
52 
53  public:
54  Plane( real o=0.0f, vec3 n=vec3(0,0,0) ): mNormal(n), mOrigin(o)
55  {
56  VL_DEBUG_SET_OBJECT_NAME()
57  }
58 
59  Plane( const vec3& o, const vec3& n )
60  {
61  VL_DEBUG_SET_OBJECT_NAME()
62  mNormal = n;
63  mOrigin = dot(o, n);
64  }
65 
66  real distance(const vec3 &v) const;
67 
70  int classify(const AABB&) const;
71 
72  bool isOutside(const AABB&) const;
73 
74  const vec3& normal() const { return mNormal; }
75 
76  real origin() const { return mOrigin; }
77 
78  void setNormal(const vec3& normal) { mNormal = normal; }
79 
80  void setOrigin(real origin) { mOrigin = origin; }
81 
82  protected:
84  real mOrigin;
85  };
86 }
87 
88 #endif
Plane(const vec3 &o, const vec3 &n)
Definition: Plane.hpp:59
The Plane class defines a plane using a normal and an origin.
Definition: Plane.hpp:49
vec3 mNormal
Definition: Plane.hpp:83
real origin() const
Definition: Plane.hpp:76
Plane(real o=0.0f, vec3 n=vec3(0, 0, 0))
Definition: Plane.hpp:54
#define VL_INSTRUMENT_CLASS(ClassName, BaseClass)
Definition: TypeInfo.hpp:122
Visualization Library main namespace.
float dot(float a, float b)
Definition: glsl_math.hpp:1111
T distance(T p0, T p1)
Definition: glsl_math.hpp:1098
The AABB class implements an axis-aligned bounding box using vl::real precision.
Definition: AABB.hpp:44
The base class for all the reference counted objects.
Definition: Object.hpp:158
Implements the OpenGL Shading Language convenience functions for scalar and vector operations...
real mOrigin
Definition: Plane.hpp:84
const vec3 & normal() const
Definition: Plane.hpp:74
fvec3 vec3
Defined as: &#39;typedef fvec3 vec3&#39;. See also VL_PIPELINE_PRECISION.
Definition: Vector3.hpp:269
void setNormal(const vec3 &normal)
Definition: Plane.hpp:78
void setOrigin(real origin)
Definition: Plane.hpp:80