include/opencascade/IGESGeom_TransformationMatrix.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( Kiran )
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESGeom_TransformationMatrix_HeaderFile
0018 #define _IGESGeom_TransformationMatrix_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <NCollection_Array2.hxx>
0024 #include <NCollection_HArray2.hxx>
0025 #include <IGESData_TransfEntity.hxx>
0026 #include <Standard_Integer.hxx>
0027 class gp_GTrsf;
0028
0029 //! defines IGESTransformationMatrix, Type <124> Form <0>
0030 //! in package IGESGeom
0031 //! The transformation matrix entity transforms three-row column
0032 //! vectors by means of matrix multiplication and then a vector
0033 //! addition. This entity can be considered as an "operator"
0034 //! entity in that it starts with the input vector, operates on
0035 //! it as described above, and produces the output vector.
0036 class IGESGeom_TransformationMatrix : public IGESData_TransfEntity
0037 {
0038
0039 public:
0040   Standard_EXPORT IGESGeom_TransformationMatrix();
0041
0042   //! This method is used to set the fields of the class
0043   //! TransformationMatrix
0044   //! - aMatrix : 3 x 4 array containing elements of the
0045   //! transformation matrix
0046   //! raises exception if aMatrix is not 3 x 4 array
0047   Standard_EXPORT void Init(const occ::handle<NCollection_HArray2<double>>& aMatrix);
0048
0049   //! Changes FormNumber (indicates the Type of Transf :
0050   //! Transformation 0-1 or Coordinate System 10-11-12)
0051   //! Error if not in ranges [0-1] or [10-12]
0052   Standard_EXPORT void SetFormNumber(const int form);
0053
0054   //! returns individual Data
0055   //! Error if I not in [1-3] or J not in [1-4]
0056   Standard_EXPORT double Data(const int I, const int J) const;
0057
0058   //! returns the transformation matrix
0059   //! 4th row elements of GTrsf will always be 0, 0, 0, 1 (not defined)
0060   Standard_EXPORT gp_GTrsf Value() const override;
0061
0062   DEFINE_STANDARD_RTTIEXT(IGESGeom_TransformationMatrix, IGESData_TransfEntity)
0063
0064 private:
0065   occ::handle<NCollection_HArray2<double>> theData;
0066 };
0067
0068 #endif // _IGESGeom_TransformationMatrix_HeaderFile