Public API Reference

csgeom/plane3.h

Go to the documentation of this file.

/*
    Copyright (C) 1998,1999,2000 by Jorrit Tyberghein
    Largely rewritten by Ivan Avramovic <[email protected]>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_PLANE3_H__
#define __CS_PLANE3_H__

#include "csextern.h"

#include "csgeom/vector3.h"

class csString;
struct csVertexStatus;

class CS_CRYSTALSPACE_EXPORT csPlane3
{
public:
  csVector3 norm;

  float DD;

  csPlane3 () : norm(0,0,1), DD(0) {}

  csPlane3 (const csVector3& plane_norm, float d=0) : norm(plane_norm), DD(d) {}

  csPlane3 (float a, float b, float c, float d=0) : norm(a,b,c), DD(d) {}

  csPlane3 (const csVector3& v1, const csVector3& v2, const csVector3& v3);

  csPlane3 (const csVector3& v2, const csVector3& v3)
  {
    norm = v2 % v3; DD = 0;
  }

  inline csVector3& Normal () { return norm; }
  inline const csVector3& Normal () const { return norm; }

  inline float A () const { return norm.x; }
  inline float B () const { return norm.y; }
  inline float C () const { return norm.z; }
  inline float D () const { return DD; }

  inline float& A () { return norm.x; }
  inline float& B () { return norm.y; }
  inline float& C () { return norm.z; }
  inline float& D () { return DD; }

  inline const csVector3& GetNormal () const { return norm; }

  inline void Set (float a, float b, float c, float d)
  { norm.x = a; norm.y = b; norm.z = c; DD = d; }

  inline void Set (const csVector3& normal, float d)
  { norm = normal; DD = d; }

  void Set (const csVector3& v1, const csVector3& v2, const csVector3& v3);

  inline void Set (const csVector3& v2, const csVector3& v3)
  {
    norm = v2 % v3; DD = 0;
  }

  inline void SetOrigin (const csVector3& p)
  {
    DD = -norm * p;
  }

  inline float Classify (const csVector3& pt) const { return norm*pt+DD; }

  static float Classify (float A, float B, float C, float D,
                         const csVector3& pt)
  {
    return A*pt.x + B*pt.y + C*pt.z + D;
  }

  inline float Distance (const csVector3& pt) const
  { return ABS (Classify (pt)); }

  inline void Invert () { norm = -norm;  DD = -DD; }

  inline void Normalize ()
  {
    float f = norm.Norm ();
    if (f) { norm /= f;  DD /= f; }
  }

  csVector3 FindPoint () const;

  bool ClipPolygon (csVector3*& pverts, int& num_verts, bool reversed = false);

  uint8 ClipPolygon (const csVector3* InVerts, size_t InCount,
    csVector3* OutPolygon, size_t& OutCount, csVertexStatus* OutStatus,
    bool reversed = false) const;

  csString Description() const;
};

#endif // __CS_PLANE3_H__

---