plane.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_BASE_GF_PLANE_H
#define PXR_BASE_GF_PLANE_H


#include "pxr/pxr.h"
#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/api.h"

#include <iosfwd>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

class GfRange3d;
class GfMatrix4d;
class GfVec4d;

class GfPlane
{
  public:

    GfPlane() {
    }

    GfPlane(const GfVec3d &normal, double distanceToOrigin) {
        Set(normal, distanceToOrigin);
    }

    GfPlane(const GfVec3d &normal, const GfVec3d &point) {
        Set(normal, point);
    }

    GfPlane(const GfVec3d &p0, const GfVec3d &p1, const GfVec3d &p2) {
        Set(p0, p1, p2);
    }

    GfPlane(const GfVec4d &eqn) {
        Set(eqn);
    }

    void                Set(const GfVec3d &normal, double distanceToOrigin) {
        _normal = normal.GetNormalized();
        _distance = distanceToOrigin;
    }

    GF_API
    void                Set(const GfVec3d &normal, const GfVec3d &point);

    GF_API
    void                Set(const GfVec3d &p0,
                            const GfVec3d &p1,
                            const GfVec3d &p2);

    GF_API
    void                Set(const GfVec4d &eqn);

    const GfVec3d &     GetNormal() const {
        return _normal;
    }

    double              GetDistanceFromOrigin() const {
        return _distance;
    }

    GF_API
    GfVec4d             GetEquation() const;

    bool                operator ==(const GfPlane &p) const {
        return (_normal   == p._normal &&
                _distance == p._distance);
    }

    bool                operator !=(const GfPlane &p) const {
        return ! (*this == p);
    }

    double              GetDistance(const GfVec3d &p) const {
        return p * _normal - _distance;
    }

    GfVec3d             Project(const GfVec3d& p) const {
        return p - GetDistance(p) * _normal;
    }

    GF_API
    GfPlane &           Transform(const GfMatrix4d &matrix);

    void                Reorient(const GfVec3d& p) {
        if (GetDistance(p) < 0) {
            _normal = -_normal;
            _distance = -_distance;
        }
    }

    GF_API
    bool IntersectsPositiveHalfSpace(const GfRange3d &box) const;

    bool IntersectsPositiveHalfSpace(const GfVec3d &pt) const {
        return GetDistance(pt) >= 0.0;
    }

  private:
    GfVec3d             _normal;

    double              _distance;
};

GF_API
bool GfFitPlaneToPoints(const std::vector<GfVec3d>& points, GfPlane* fitPlane);

GF_API std::ostream& operator<<(std::ostream&, const GfPlane&);

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_BASE_GF_PLANE_H