include/opencascade/IGESBasic_SingularSubfigure.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
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 _IGESBasic_SingularSubfigure_HeaderFile
0018 #define _IGESBasic_SingularSubfigure_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XYZ.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 class IGESBasic_SubfigureDef;
0026
0027 //! defines SingularSubfigure, Type <408> Form <0>
0028 //! in package IGESBasic
0029 //! Defines the occurrence of a single instance of the
0030 //! defined Subfigure.
0031 class IGESBasic_SingularSubfigure : public IGESData_IGESEntity
0032 {
0033
0034 public:
0035   Standard_EXPORT IGESBasic_SingularSubfigure();
0036
0037   //! This method is used to set the fields of the class
0038   //! SingularSubfigure
0039   //! - aSubfigureDef : the Subfigure Definition entity
0040   //! - aTranslation  : used to store the X,Y,Z coord
0041   //! - hasScale      : Indicates the presence of scale factor
0042   //! - aScale        : Used to store the scale factor
0043   Standard_EXPORT void Init(const occ::handle<IGESBasic_SubfigureDef>& aSubfigureDef,
0044                             const gp_XYZ&                              aTranslation,
0045                             const bool                                 hasScale,
0046                             const double                               aScale);
0047
0048   //! returns the subfigure definition entity
0049   Standard_EXPORT occ::handle<IGESBasic_SubfigureDef> Subfigure() const;
0050
0051   //! returns the X, Y, Z coordinates
0052   Standard_EXPORT gp_XYZ Translation() const;
0053
0054   //! returns the scale factor
0055   //! if hasScaleFactor is False, returns 1.0 (default)
0056   Standard_EXPORT double ScaleFactor() const;
0057
0058   //! returns a boolean indicating whether scale factor
0059   //! is present or not
0060   Standard_EXPORT bool HasScaleFactor() const;
0061
0062   //! returns the Translation after transformation
0063   Standard_EXPORT gp_XYZ TransformedTranslation() const;
0064
0065   DEFINE_STANDARD_RTTIEXT(IGESBasic_SingularSubfigure, IGESData_IGESEntity)
0066
0067 private:
0068   occ::handle<IGESBasic_SubfigureDef> theSubfigureDef;
0069   gp_XYZ                              theTranslation;
0070   double                              theScaleFactor;
0071   bool                                hasScaleFactor;
0072 };
0073
0074 #endif // _IGESBasic_SingularSubfigure_HeaderFile