OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgrePCPlane.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 OgrePCPlane.h - Portal Culling Plane
28 
29 Specialized Plane that is customized for working with the PCZSceneManager.
30 Each Plane has a pointer to the Portal which was used to create it
31 Portal Culling Planes are created from one side of a portal and the
32 origin of a camera.
33 
34 -----------------------------------------------------------------------------
35 begin : Mon Feb 26 2007
36 author : Eric Cha
37 email : ericc@xenopi.com
38 Code Style Update :
39 -----------------------------------------------------------------------------
40 */
41 
42 #ifndef PC_PLANE_H
43 #define PC_PLANE_H
44 
45 #include "OgrePlane.h"
46 #include "OgrePCZPrerequisites.h"
47 
48 namespace Ogre
49 {
50  class PortalBase;
51 
52 
54  {
55  public:
57  PCPlane();
59  PCPlane (const Plane & plane);
61  PCPlane (const Vector3& rkNormal, const Vector3& rkPoint);
63  PCPlane (const Vector3& rkPoint0, const Vector3& rkPoint1, const Vector3& rkPoint2);
65  void setFromOgrePlane(Plane & ogrePlane);
66 
68  ~PCPlane();
69 
73  {
74  return mPortal;
75  };
76 
80  {
81  mPortal = o;
82  };
83 
84 
85  protected:
86 
88  PortalBase *mPortal;
89  };
90 
91 }
92 
93 
94 #endif
void setPortal(PortalBase *o)
Sets the Portal that was used to create this plane.
Definition: OgrePCPlane.h:79
Defines a plane in 3D space.
Definition: OgrePlane.h:61
PortalBase - Base class to Portal and AntiPortal classes.
#define _OgrePCZPluginExport
Standard 3-dimensional vector.
Definition: OgreVector3.h:50
PortalBase * getPortal()
Returns the Portal that was used to create this plane.
Definition: OgrePCPlane.h:72