-/*******************************************************************************
-
- Copyright (c) 2009, Charles McGarvey
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are met:
-
- * Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-*******************************************************************************/
+/*] Copyright (c) 2009-2010, Charles McGarvey [**************************
+**] All rights reserved.
+*
+* vi:ts=4 sw=4 tw=75
+*
+* Distributable under the terms and conditions of the 2-clause BSD license;
+* see the file COPYING for a complete text of the license.
+*
+**************************************************************************/
#ifndef _MOOF_PLANE_HH_
#define _MOOF_PLANE_HH_
/*
- * A plane in 3-space defined by the equation Ax + By + Cz = D, where [A, B, C]
- * is normal to the plane.
+ * A plane in 3-space defined by the equation Ax + By + Cz = D, where [A,
+ * B, C] is normal to the plane.
*/
struct Plane : public Shape<3>
d(scalar) {}
- bool intersectRay(const Ray<3>& ray, Ray<3>::Intersection& hit)
+ bool intersectRay(const Ray<3>& ray, Ray<3>::Contact& hit)
{
// solve: [(ray.point + t*ray.direction) dot normal] + d = 0
}
- /* Causes the normal of the plane to become normalized. The scalar may also
- * be changed to keep the equation true. Word to the wise: don't normalize
- * a plane if the normal is the zero vector. */
+ /* Causes the normal of the plane to become normalized. The scalar may
+ * also be changed to keep the equation true. Word to the wise: don't
+ * normalize a plane if the normal is the zero vector.
+ */
void normalize()
{
Scalar mag = normal.length();
}
/**
- * Determine the shortest distance between a point and the plane. */
-
+ * Determine the shortest distance between a point and the plane.
+ */
Scalar getDistanceToPoint(const Vector3& point) const
{
return cml::dot(point, normal) + d;
#endif // _MOOF_PLANE_HH_
-/** vim: set ts=4 sw=4 tw=80: *************************************************/
-