src/TopLoc/TopLoc_Datum3D.hxx

   1 // Created on: 1991-01-23
   2 // Created by: Christophe MARION
   3 // Copyright (c) 1991-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 _TopLoc_Datum3D_HeaderFile
  18 #define _TopLoc_Datum3D_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <gp_Trsf.hxx>
  24 #include <Standard_Transient.hxx>
  25 #include <Standard_OStream.hxx>
  26 class Standard_ConstructionError;
  27 class gp_Trsf;
  28
  29
  30 class TopLoc_Datum3D;
  31 DEFINE_STANDARD_HANDLE(TopLoc_Datum3D, Standard_Transient)
  32
  33 //! Describes a coordinate transformation, i.e. a change
  34 //! to an elementary 3D coordinate system, or position in 3D space.
  35 //! A Datum3D is always described relative to the default datum.
  36 //! The default datum is described relative to itself: its
  37 //! origin is (0,0,0), and its axes are (1,0,0) (0,1,0) (0,0,1).
  38 class TopLoc_Datum3D : public Standard_Transient
  39 {
  40
  41 public:
  42
  43
  44   //! Constructs a default Datum3D.
  45   Standard_EXPORT TopLoc_Datum3D();
  46
  47   //! Constructs a Datum3D form a Trsf from gp. An error is
  48   //! raised if the Trsf is not a rigid transformation.
  49   Standard_EXPORT TopLoc_Datum3D(const gp_Trsf& T);
  50
  51   //! Returns a gp_Trsf which, when applied to this datum,
  52   //! produces the default datum.
  53     const gp_Trsf& Transformation() const;
  54
  55
  56   //! Dumps the content of me into the stream
  57   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, const Standard_Integer theDepth = -1) const;
  58
  59   //! Writes the contents of this Datum3D to the stream S.
  60   Standard_EXPORT void ShallowDump (Standard_OStream& S) const;
  61
  62
  63
  64
  65   DEFINE_STANDARD_RTTIEXT(TopLoc_Datum3D,Standard_Transient)
  66
  67 protected:
  68
  69
  70
  71
  72 private:
  73
  74
  75   gp_Trsf myTrsf;
  76
  77
  78 };
  79
  80
  81 #include <TopLoc_Datum3D.lxx>
  82
  83
  84
  85 inline void ShallowDump(const Handle(TopLoc_Datum3D)& me,Standard_OStream& S) {
  86  me->ShallowDump(S);
  87 }
  88
  89
  90
  91 #endif // _TopLoc_Datum3D_HeaderFile