Visualization Library 2.1.0

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

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
ClipPlane.hpp
Go to the documentation of this file.
1 /**************************************************************************************/
2 /* */
3 /* Visualization Library */
4 /* http://visualizationlibrary.org */
5 /* */
6 /* Copyright (c) 2005-2020, 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 ClipPlane_INCLUDE_ONCE
33 #define ClipPlane_INCLUDE_ONCE
34 
35 #include <vlCore/Plane.hpp>
36 #include <vlGraphics/Camera.hpp>
38 
39 namespace vl
40 {
41  //-----------------------------------------------------------------------------
42  // ClipPlane
43  //-----------------------------------------------------------------------------
50  {
52 
53  public:
54 
56  ClipPlane(real o=0.0f, vec3 n=vec3(0,0,0));
57 
59  ClipPlane(const vec3& o, const vec3& n);
60 
62  virtual ERenderState type() const { return RS_ClipPlane; }
63 
65  virtual void apply(int index, const Camera* camera, OpenGLContext*) const;
66 
68  void bindTransform(Transform* transform) { mBoundTransform = transform; }
69 
71  Transform* boundTransform() { return mBoundTransform.get(); }
72 
74  const Transform* boundTransform() const { return mBoundTransform.get(); }
75 
77  const Plane& plane() const { return mPlane; }
78 
80  Plane& plane() { return mPlane; }
81 
83  void setPlane(const Plane& plane) { mPlane = plane; }
84 
85  virtual ref<RenderState> clone() const
86  {
87  ref<ClipPlane> rs = new ClipPlane;
88  *rs = *this;
89  return rs;
90  }
91 
92  void setEnabled(bool enabled) { mEnabled = enabled; }
93 
94  bool enabled() const { return mEnabled; }
95 
96  protected:
99  bool mEnabled;
100  };
101  //-----------------------------------------------------------------------------
102 }
103 
104 #endif
void setEnabled(bool enabled)
Definition: ClipPlane.hpp:92
Implements a 4x4 matrix transform used to define the position and orientation of an Actor...
Definition: Transform.hpp:72
ERenderState
The Plane class defines a plane using a normal and an origin.
Definition: Plane.hpp:49
virtual ref< RenderState > clone() const
Definition: ClipPlane.hpp:85
void bindTransform(Transform *transform)
Attach the light to a vl::Transform.
Definition: ClipPlane.hpp:68
void setPlane(const Plane &plane)
Defines the actual plane used to perform the clipping.
Definition: ClipPlane.hpp:83
Represents an OpenGL context, possibly a widget or a pbuffer, which can also respond to keyboard...
Base class for those render states which have more than one binding points like lights, clipping planes and texture unit states.
Definition: RenderState.hpp:70
Plane & plane()
Returns the actual plane used to perform the clipping.
Definition: ClipPlane.hpp:80
#define VL_INSTRUMENT_CLASS(ClassName, BaseClass)
Definition: TypeInfo.hpp:122
Visualization Library main namespace.
Transform * boundTransform()
Returns the vl::Transform to which the Light is attached.
Definition: ClipPlane.hpp:71
Wraps the OpenGL function glClipPlane().
Definition: ClipPlane.hpp:49
const Transform * boundTransform() const
Returns the vl::Transform to which the Light is attached.
Definition: ClipPlane.hpp:74
const Plane & plane() const
Returns the actual plane used to perform the clipping.
Definition: ClipPlane.hpp:77
bool enabled() const
Definition: ClipPlane.hpp:94
virtual ERenderState type() const
Returns RS_ClipPlane0.
Definition: ClipPlane.hpp:62
fvec3 vec3
Defined as: &#39;typedef fvec3 vec3&#39;. See also VL_PIPELINE_PRECISION.
Definition: Vector3.hpp:270
ref< Transform > mBoundTransform
Definition: ClipPlane.hpp:97
The ref<> class is used to reference-count an Object.
Definition: Object.hpp:55
Represents a virtual camera defining, among other things, the point of view from which scenes can be ...
Definition: Camera.hpp:49