SbPlane.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2022 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
#ifndef _SB_PLANE_
#define _SB_PLANE_
 
#include <Inventor/SbVec.h>
 
class SbLine;
class SbMatrix;
 
//
//  Class: SbPlane
//
//  Represents an oriented plane in 3D space. The plane is defined by
//  a plane normal and a distance from the origin along that normal.
//  SbPlanes may be used to represent either planes or half-spaces. In
//  the latter case (as for the isInHalfSpace() method), the
//  half-space is defined to be all points on the plane or on the side
//  of the plane in the direction of the plane normal.
//
//  The 4 coefficients of the plane equation of an SbPlane can be
//  obtained easily as the 3 coordinates of the plane normal and the
//  distance, in that order.
//
 
 
class  SbPlane {
public:
  SbPlane()  {}
 
  SbPlane(const SbVec3f &p0, const SbVec3f &p1, const SbVec3f &p2);
 
  SbPlane(const SbVec3f &normal, float distance);
 
  SbPlane(const SbVec3f &normal, const SbVec3f &point);
 
  void    offset(float d);
 
  SbBool intersect(const SbLine &l,
    SbVec3f &intersection) const;
 
  void    transform(const SbMatrix &matrix);
 
  SbBool    isInHalfSpace(const SbVec3f &point) const;
 
 
  const SbVec3f &getNormal() const    { return normalVec; }
  float    getDistanceFromOrigin() const  { return distance; }
 
   friend int operator ==(const SbPlane &p1, const SbPlane &p2);
   friend int operator !=(const SbPlane &p1, const SbPlane &p2)
  { return !(p1 == p2); }
 
  float getDistance(const SbVec3f &point) const;
 
private:
  enum PlanePlaneIntersectionResult
  {
    DISJOINT_PARALLEL_PLANES = 0,
    COINCIDENT_PLANES = 1,
    INCIDENT_PLANES = 2,
  };
 
  PlanePlaneIntersectionResult intersect( const SbPlane &p, SbLine &intersection, float angTol = 10.e-3f ) const;
 
private:
  // Plane is all p such that normalVec . p - distance = 0
 
  // Normal to the plane
  SbVec3f  normalVec;
 
  // Distance from origin to plane: distance * normalVec is on the plane
  float  distance;
 
};
 
 
#endif /* _SB_PLANE_ */