UT_OBBox.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_OBBox.h ( UT Library, C++)
 *
 * COMMENTS:
 */

#ifndef __UT_OBBox_h__
#define __UT_OBBox_h__

#include "UT_API.h"
#include "UT_Matrix3.h"
#include "UT_Vector3.h"
#include "UT_BoundingBox.h"

template<typename T>
class UT_Array;

/// Arbitrarily Oriented Bounding (OBB)
template <typename T>
class UT_API UT_OBBoxT
{
public:
    UT_OBBoxT();
    /// Construct the OBB from a transform and radii.
    UT_OBBoxT(const UT_Matrix4T<T> &transform, const UT_Vector3T<T> &radii);
    /// Construct the OBB from a set of points.
    UT_OBBoxT(const UT_Array<UT_Vector3T<T> > &points, int refinement = 6);
    /// Construct the OBB using the instancing parameters. Note that size is the
    /// full size in this case--not radii or half-sizes!
    UT_OBBoxT(const UT_Vector3T<T> &position, const UT_Vector3T<T> &size,
              const UT_QuaternionT<T> &orientation,
              const UT_Vector3T<T> &pivot = UT_Vector3T<T>((T) 0));

    bool operator==(const UT_OBBoxT<T> &other) const;

    /// Return whether the bbox is valid (contains any points).
    bool isValid() const;

    /// Calculate the OBB for the set of points
    void calcOBB(const UT_Array<UT_Vector3T<T> > &points, int refinement = 6);

    /// Return the basis that defines the orientation of the OBB
    /// Note: this is the transpose of what you probably expect.
    SYS_DEPRECATED_REPLACE(19.5, "getRotationMatrix")
    UT_Matrix3T<T> getBasis() const;

    /// Return the rotation matrix of the OBB.
    const UT_Matrix3T<T> &getRotationMatrix() const { return myBasis; }

    /// Return the half radii(side length) of the OBB
    UT_Vector3T<T> getRadii() const {return myRadii;}
    /// Return the euler rotation angles (in radians).
    UT_Vector3T<T> getRotation() const;
    /// Return the center of the OBB
    UT_Vector3T<T> getCenter() const {return myCenter;}
    /// Return the tranform matrix of the OBB
    UT_Matrix4T<T> getTransform() const;
    /// Return the untransformed bounding box.
    UT_BoundingBoxT<T> getBBox() const;
    /// Return the given axis direction
    UT_Vector3T<T> getAxis(int axis) const;
    /// Return the minimum axis direction
    UT_Vector3T<T> getMinAxis() const;
    /// Return the maximum axis direction
    UT_Vector3T<T> getMaxAxis() const;

    /// Checks whether this oriented bouding box intersects other.
    bool intersects(const UT_OBBoxT<T>& other) const;

    /// Test whether the point is contained inside the box.
    bool isInside(const UT_Vector3T<T> &pt) const;

private:
    UT_Matrix3T<T>      myBasis;
    UT_Vector3T<T>      myCenter;
    UT_Vector3T<T>      myRadii;
};

typedef UT_OBBoxT<fpreal>       UT_OBBoxR;
typedef UT_OBBoxT<fpreal32>     UT_OBBoxF;
typedef UT_OBBoxT<fpreal64>     UT_OBBoxD;
typedef UT_OBBoxT<float>        UT_OBBox;       // deprecated

#endif