src/IGESGeom/IGESGeom_Plane.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( Kiran )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESGeom_Plane_HeaderFile
  18 #define _IGESGeom_Plane_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Real.hxx>
  24 #include <gp_XYZ.hxx>
  25 #include <IGESData_IGESEntity.hxx>
  26 #include <Standard_Integer.hxx>
  27 #include <Standard_Boolean.hxx>
  28 class IGESData_IGESEntity;
  29 class gp_XYZ;
  30 class gp_Pnt;
  31
  32
  33 class IGESGeom_Plane;
  34 DEFINE_STANDARD_HANDLE(IGESGeom_Plane, IGESData_IGESEntity)
  35
  36 //! defines IGESPlane, Type <108> Form <-1,0,1>
  37 //! in package IGESGeom
  38 //! A plane entity can be used to represent unbounded plane,
  39 //! as well as bounded portion of a plane. In either of the
  40 //! above cases the plane is defined within definition space
  41 //! by means of coefficients A, B, C, D where at least one of
  42 //! A, B, C is non-zero and  A * XT + B * YT + C * ZT = D
  43 class IGESGeom_Plane : public IGESData_IGESEntity
  44 {
  45
  46 public:
  47
  48
  49   Standard_EXPORT IGESGeom_Plane();
  50
  51   Standard_EXPORT void Init (const Standard_Real A, const Standard_Real B, const Standard_Real C, const Standard_Real D, const Handle(IGESData_IGESEntity)& aCurve, const gp_XYZ& attach, const Standard_Real aSize);
  52
  53   //! Changes FormNumber (indicates the Type of Bound :
  54   //! 0 no Bound, 1 (External) Bound, -1 Hole)
  55   //! Remark that Init keeps this Value and must be consistent :
  56   //! aCurve Null if FormNumber = 0, Non-Null else
  57   //! Error if not in ranges [0-1] or [10-12]
  58   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
  59
  60   Standard_EXPORT void Equation (Standard_Real& A, Standard_Real& B, Standard_Real& C, Standard_Real& D) const;
  61
  62   Standard_EXPORT void TransformedEquation (Standard_Real& A, Standard_Real& B, Standard_Real& C, Standard_Real& D) const;
  63
  64   //! returns True if there exists a bounding curve
  65   Standard_EXPORT Standard_Boolean HasBoundingCurve() const;
  66
  67   //! returns True if bounding curve exists and bounded portion is negative
  68   Standard_EXPORT Standard_Boolean HasBoundingCurveHole() const;
  69
  70   //! returns Optional Bounding Curve, can be positive (normal clipping)
  71   //! or negative (hole) according to Form Number
  72   Standard_EXPORT Handle(IGESData_IGESEntity) BoundingCurve() const;
  73
  74   //! returns True if SymbolSize() > 0, False if SymbolSize() = 0
  75   Standard_EXPORT Standard_Boolean HasSymbolAttach() const;
  76
  77   //! returns (X, Y, Z) if symbol exists else returns (0, 0, 0)
  78   Standard_EXPORT gp_Pnt SymbolAttach() const;
  79
  80   //! returns (X, Y, Z) if symbol exists after applying Transf. Matrix
  81   //! else returns (0, 0, 0)
  82   Standard_EXPORT gp_Pnt TransformedSymbolAttach() const;
  83
  84   //! Size of optional display symbol
  85   Standard_EXPORT Standard_Real SymbolSize() const;
  86
  87
  88
  89
  90   DEFINE_STANDARD_RTTIEXT(IGESGeom_Plane,IGESData_IGESEntity)
  91
  92 protected:
  93
  94
  95
  96
  97 private:
  98
  99
 100   Standard_Real theA;
 101   Standard_Real theB;
 102   Standard_Real theC;
 103   Standard_Real theD;
 104   Handle(IGESData_IGESEntity) theCurve;
 105   gp_XYZ theAttach;
 106   Standard_Real theSize;
 107
 108
 109 };
 110
 111
 112
 113
 114
 115
 116
 117 #endif // _IGESGeom_Plane_HeaderFile