OGRE: OgrePlane.h Source File - OGRE Documentation

# OgrePlane.h

Go to the documentation of this file.

    00001 /*
    00002 -----------------------------------------------------------------------------
    00003 This source file is part of OGRE
    00004     (Object-oriented Graphics Rendering Engine)
    00005 For the latest info, see http://www.ogre3d.org/
    00006
    00007 Copyright (c) 2000-2006 Torus Knot Software Ltd
    00008 Also see acknowledgements in Readme.html
    00009
    00010 This program is free software; you can redistribute it and/or modify it under
    00011 the terms of the GNU Lesser General Public License as published by the Free Software
    00012 Foundation; either version 2 of the License, or (at your option) any later
    00013 version.
    00014
    00015 This program is distributed in the hope that it will be useful, but WITHOUT
    00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
    00018
    00019 You should have received a copy of the GNU Lesser General Public License along with
    00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
    00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
    00022 http://www.gnu.org/copyleft/lesser.txt.
    00023
    00024 You may alternatively use this source under the terms of a specific version of
    00025 the OGRE Unrestricted License provided you have obtained such a license from
    00026 Torus Knot Software Ltd.
    00027 -----------------------------------------------------------------------------
    00028 */
    00029 // Original free version by:
    00030 // Magic Software, Inc.
    00031 // http://www.geometrictools.com/
    00032 // Copyright (c) 2000, All Rights Reserved
    00033
    00034 #ifndef __Plane_H__
    00035 #define __Plane_H__
    00036
    00037 #include "OgrePrerequisites.h"
    00038
    00039 #include "OgreVector3.h"
    00040
    00041 namespace Ogre {
    00042
    00053     class _OgreExport Plane
    00054     {
    00055     public:
    00058         Plane ();
    00059         Plane (const Plane& rhs);
    00061         Plane (const Vector3& rkNormal, Real fConstant);
    00063         Plane (Real a, Real b, Real c, Real d);
    00064         Plane (const Vector3& rkNormal, const Vector3& rkPoint);
    00065         Plane (const Vector3& rkPoint0, const Vector3& rkPoint1,
    00066             const Vector3& rkPoint2);
    00067
    00072         enum Side
    00073         {
    00074             NO_SIDE,
    00075             POSITIVE_SIDE,
    00076             NEGATIVE_SIDE,
    00077             BOTH_SIDE
    00078         };
    00079
    00080         Side getSide (const Vector3& rkPoint) const;
    00081
    00086         Side getSide (const AxisAlignedBox& rkBox) const;
    00087
    00097         Side getSide (const Vector3& centre, const Vector3& halfSize) const;
    00098
    00107         Real getDistance (const Vector3& rkPoint) const;
    00108
    00110         void redefine(const Vector3& rkPoint0, const Vector3& rkPoint1,
    00111             const Vector3& rkPoint2);
    00112
    00114         void redefine(const Vector3& rkNormal, const Vector3& rkPoint);
    00115
    00123         Vector3 projectVector(const Vector3& v) const;
    00124
    00134         Real normalise(void);
    00135
    00136         Vector3 normal;
    00137         Real d;
    00138
    00140         bool operator==(const Plane& rhs) const
    00141         {
    00142             return (rhs.d == d && rhs.normal == normal);
    00143         }
    00144         bool operator!=(const Plane& rhs) const
    00145         {
    00146             return (rhs.d != d && rhs.normal != normal);
    00147         }
    00148
    00149         _OgreExport friend std::ostream& operator<< (std::ostream& o, const Plane& p);
    00150     };
    00151
    00152     typedef std::vector<Plane> PlaneList;
    00153
    00154 } // namespace Ogre
    00155
    00156 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:32:19 2009