src/IGESGeom/IGESGeom_TransformationMatrix.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_TransformationMatrix_HeaderFile
  18 #define _IGESGeom_TransformationMatrix_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <TColStd_HArray2OfReal.hxx>
  24 #include <IGESData_TransfEntity.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <Standard_Real.hxx>
  27 class Standard_DimensionMismatch;
  28 class Standard_OutOfRange;
  29 class gp_GTrsf;
  30
  31
  32 class IGESGeom_TransformationMatrix;
  33 DEFINE_STANDARD_HANDLE(IGESGeom_TransformationMatrix, IGESData_TransfEntity)
  34
  35 //! defines IGESTransformationMatrix, Type <124> Form <0>
  36 //! in package IGESGeom
  37 //! The transformation matrix entity transforms three-row column
  38 //! vectors by means of matrix multiplication and then a vector
  39 //! addition. This entity can be considered as an "operator"
  40 //! entity in that it starts with the input vector, operates on
  41 //! it as described above, and produces the output vector.
  42 class IGESGeom_TransformationMatrix : public IGESData_TransfEntity
  43 {
  44
  45 public:
  46
  47
  48   Standard_EXPORT IGESGeom_TransformationMatrix();
  49
  50   //! This method is used to set the fields of the class
  51   //! TransformationMatrix
  52   //! - aMatrix : 3 x 4 array containing elements of the
  53   //! transformation matrix
  54   //! raises exception if aMatrix is not 3 x 4 array
  55   Standard_EXPORT void Init (const Handle(TColStd_HArray2OfReal)& aMatrix);
  56
  57   //! Changes FormNumber (indicates the Type of Transf :
  58   //! Transformation 0-1 or Coordinate System 10-11-12)
  59   //! Error if not in ranges [0-1] or [10-12]
  60   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
  61
  62   //! returns individual Data
  63   //! Error if I not in [1-3] or J not in [1-4]
  64   Standard_EXPORT Standard_Real Data (const Standard_Integer I, const Standard_Integer J) const;
  65
  66   //! returns the transformation matrix
  67   //! 4th row elements of GTrsf will always be 0, 0, 0, 1 (not defined)
  68   Standard_EXPORT gp_GTrsf Value() const Standard_OVERRIDE;
  69
  70
  71
  72
  73   DEFINE_STANDARD_RTTIEXT(IGESGeom_TransformationMatrix,IGESData_TransfEntity)
  74
  75 protected:
  76
  77
  78
  79
  80 private:
  81
  82
  83   Handle(TColStd_HArray2OfReal) theData;
  84
  85
  86 };
  87
  88
  89
  90
  91
  92
  93
  94 #endif // _IGESGeom_TransformationMatrix_HeaderFile