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-2009 Torus Knot Software Ltd
    00008
    00009 Permission is hereby granted, free of charge, to any person obtaining a copy
    00010 of this software and associated documentation files (the "Software"), to deal
    00011 in the Software without restriction, including without limitation the rights
    00012 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    00013 copies of the Software, and to permit persons to whom the Software is
    00014 furnished to do so, subject to the following conditions:
    00015
    00016 The above copyright notice and this permission notice shall be included in
    00017 all copies or substantial portions of the Software.
    00018
    00019 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    00020 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    00021 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    00022 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    00023 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    00024 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    00025 THE SOFTWARE.
    00026 -----------------------------------------------------------------------------
    00027 */
    00028 // This file is based on material originally from:
    00029 // Geometric Tools, LLC
    00030 // Copyright (c) 1998-2010
    00031 // Distributed under the Boost Software License, Version 1.0.
    00032 // http://www.boost.org/LICENSE_1_0.txt
    00033 // http://www.geometrictools.com/License/Boost/LICENSE_1_0.txt
    00034
    00035
    00036 #ifndef __Plane_H__
    00037 #define __Plane_H__
    00038
    00039 #include "OgrePrerequisites.h"
    00040
    00041 #include "OgreVector3.h"
    00042
    00043 namespace Ogre {
    00044
    00061     class _OgreExport Plane
    00062     {
    00063     public:
    00066         Plane ();
    00067         Plane (const Plane& rhs);
    00069         Plane (const Vector3& rkNormal, Real fConstant);
    00071         Plane (Real a, Real b, Real c, Real d);
    00072         Plane (const Vector3& rkNormal, const Vector3& rkPoint);
    00073         Plane (const Vector3& rkPoint0, const Vector3& rkPoint1,
    00074             const Vector3& rkPoint2);
    00075
    00080         enum Side
    00081         {
    00082             NO_SIDE,
    00083             POSITIVE_SIDE,
    00084             NEGATIVE_SIDE,
    00085             BOTH_SIDE
    00086         };
    00087
    00088         Side getSide (const Vector3& rkPoint) const;
    00089
    00094         Side getSide (const AxisAlignedBox& rkBox) const;
    00095
    00105         Side getSide (const Vector3& centre, const Vector3& halfSize) const;
    00106
    00115         Real getDistance (const Vector3& rkPoint) const;
    00116
    00118         void redefine(const Vector3& rkPoint0, const Vector3& rkPoint1,
    00119             const Vector3& rkPoint2);
    00120
    00122         void redefine(const Vector3& rkNormal, const Vector3& rkPoint);
    00123
    00131         Vector3 projectVector(const Vector3& v) const;
    00132
    00142         Real normalise(void);
    00143
    00144         Vector3 normal;
    00145         Real d;
    00146
    00148         bool operator==(const Plane& rhs) const
    00149         {
    00150             return (rhs.d == d && rhs.normal == normal);
    00151         }
    00152         bool operator!=(const Plane& rhs) const
    00153         {
    00154             return (rhs.d != d && rhs.normal != normal);
    00155         }
    00156
    00157         _OgreExport friend std::ostream& operator<< (std::ostream& o, const Plane& p);
    00158     };
    00159
    00160     typedef vector<Plane>::type PlaneList;
    00164 } // namespace Ogre
    00165
    00166 #endif

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:24:52