common/plane.h

// Version:    <1.0>
//
// Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple Inc. ("Apple")
//             in consideration of your agreement to the following terms, and your use,
//             installation, modification or redistribution of this Apple software
//             constitutes acceptance of these terms.  If you do not agree with these
//             terms, please do not use, install, modify or redistribute this Apple
//             software.
//
//             In consideration of your agreement to abide by the following terms, and
//             subject to these terms, Apple grants you a personal, non - exclusive
//             license, under Apple's copyrights in this original Apple software ( the
//             "Apple Software" ), to use, reproduce, modify and redistribute the Apple
//             Software, with or without modifications, in source and / or binary forms;
//             provided that if you redistribute the Apple Software in its entirety and
//             without modifications, you must retain this notice and the following text
//             and disclaimers in all such redistributions of the Apple Software. Neither
//             the name, trademarks, service marks or logos of Apple Inc. may be used to
//             endorse or promote products derived from the Apple Software without specific
//             prior written permission from Apple.  Except as expressly stated in this
//             notice, no other rights or licenses, express or implied, are granted by
//             Apple herein, including but not limited to any patent rights that may be
//             infringed by your derivative works or by other works in which the Apple
//             Software may be incorporated.
//
//             The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO
//             WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
//             WARRANTIES OF NON - INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A
//             PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION
//             ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
//
//             IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
//             CONSEQUENTIAL DAMAGES ( INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
//             SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
//             INTERRUPTION ) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
//             AND / OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER
//             UNDER THEORY OF CONTRACT, TORT ( INCLUDING NEGLIGENCE ), STRICT LIABILITY OR
//             OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright ( C ) 2008 Apple Inc. All Rights Reserved.
//
////////////////////////////////////////////////////////////////////////////////////////////////////
 
#ifndef __PLANE_H__
#define __PLANE_H__
 
#include "compute_math.h"
 
class Plane
{
 
public:
 
    Plane();
    Plane(const Plane &rfOther);
    Plane(const float3 &rfP0, const float3 &rfP1, const float3 &rfP2);
    Plane(const float3 &rkNormal, float fConstant);
    Plane(const float3 &rkPoint, const float3 &rkNormal);
    
    Plane& operator= (const Plane& rkOther);
    
    float dotNormal(const float3 &rkNormal) const;
    
    int side(const float3 &rkPoint) const;
    
    float distance(const float3 &rkPoint) const;
    
    bool findIntersection(
        float3 &rfIntersection,
        const float3 &rkPoint,
        const float3 &rkDir,
        float fZeroEpsilon = 1e-06f) const;
        
    bool findIntersection(
        float &rfT, 
        const float3 &rkPoint, 
        const float3 &rkDir, 
        float fZeroEpsilon = 1e-06f) const;
        
    bool intersects(
        const float3 &rkPoint, 
        const float3 &rkDir, 
        float fZeroEpsilon = 1e-06f) const;
 
    const float3 &getNormal() const                { return m_kNormal; }
    float getConstant()                            { return m_fConstant; }
    
protected:
 
    float3 m_kNormal;
    float m_fConstant;
 
};
 
#endif