bbox3d.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_BBOX3D_H
#define PXR_BASE_GF_BBOX3D_H


#include "pxr/pxr.h"
#include "pxr/base/gf/matrix4d.h"
#include "pxr/base/gf/range3d.h"
#include "pxr/base/gf/api.h"

#include <iosfwd>

PXR_NAMESPACE_OPEN_SCOPE

class GfBBox3d {

  public:

    GfBBox3d() {
        _matrix.SetIdentity();
        _inverse.SetIdentity();
        _isDegenerate = false;
        _hasZeroAreaPrimitives = false;
    }

    GfBBox3d(const GfBBox3d& rhs) :
        _box(rhs._box) {
        _matrix = rhs._matrix;
        _inverse = rhs._inverse;
        _isDegenerate = rhs._isDegenerate;
        _hasZeroAreaPrimitives = rhs._hasZeroAreaPrimitives;
    }

    GfBBox3d(const GfRange3d &box) :
        _box(box) {
        _matrix.SetIdentity();
        _inverse.SetIdentity();
        _isDegenerate = false;
        _hasZeroAreaPrimitives = false;
    }

    GfBBox3d(const GfRange3d &box, const GfMatrix4d &matrix) {
        Set(box, matrix);
        _hasZeroAreaPrimitives = false;
    }

    void                Set(const GfRange3d &box, const GfMatrix4d &matrix) {
        _box = box;
        _SetMatrices(matrix);
    }

    void                SetMatrix(const GfMatrix4d& matrix) {
        _SetMatrices(matrix);
    }

    void                SetRange(const GfRange3d& box) {
        _box = box;
    }

    const GfRange3d &   GetRange() const {
        return _box;
    }

    const GfRange3d &   GetBox() const {
        return GetRange();
    }

    const GfMatrix4d &  GetMatrix() const {
        return _matrix;
    }

    const GfMatrix4d &  GetInverseMatrix() const {
        return _inverse;
    }

    void                SetHasZeroAreaPrimitives(bool hasThem) {
        _hasZeroAreaPrimitives = hasThem;
    }

    bool                HasZeroAreaPrimitives() const {
        return _hasZeroAreaPrimitives;
    }

    GF_API
    double              GetVolume() const;

    void                Transform(const GfMatrix4d &matrix) {
        _SetMatrices(_matrix * matrix);
    }

    GF_API
    GfRange3d           ComputeAlignedRange() const;

    GfRange3d           ComputeAlignedBox() const {
        return ComputeAlignedRange();
    }

    GF_API
    static GfBBox3d     Combine(const GfBBox3d &b1, const GfBBox3d &b2);

    GF_API
    GfVec3d             ComputeCentroid() const;

    friend inline size_t hash_value(const GfBBox3d &b) {
        return TfHash::Combine(
            b._box,
            b._matrix
        );
    }
    
    bool                operator ==(const GfBBox3d &b) const {
        return (_box    == b._box &&
                _matrix == b._matrix);
    }

    bool                operator !=(const GfBBox3d &that) const {
        return !(*this == that);
    }

  private:
    GfRange3d           _box;
    GfMatrix4d          _matrix;
    GfMatrix4d          _inverse;
    bool                _isDegenerate;
    bool                _hasZeroAreaPrimitives;

    GF_API
    void                _SetMatrices(const GfMatrix4d &matrix);

    static GfBBox3d     _CombineInOrder(const GfBBox3d &b1, const GfBBox3d &b2);
};

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

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_BASE_GF_BBOX3D_H