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
0028 class IGESBasic_SingularSubfigure;
0029 DEFINE_STANDARD_HANDLE(IGESBasic_SingularSubfigure, IGESData_IGESEntity)
0030
0031 //! defines SingularSubfigure, Type <408> Form <0>
0032 //! in package IGESBasic
0033 //! Defines the occurrence of a single instance of the
0034 //! defined Subfigure.
0035 class IGESBasic_SingularSubfigure : public IGESData_IGESEntity
0036 {
0037
0038 public:
0039
0040
0041   Standard_EXPORT IGESBasic_SingularSubfigure();
0042
0043   //! This method is used to set the fields of the class
0044   //! SingularSubfigure
0045   //! - aSubfigureDef : the Subfigure Definition entity
0046   //! - aTranslation  : used to store the X,Y,Z coord
0047   //! - hasScale      : Indicates the presence of scale factor
0048   //! - aScale        : Used to store the scale factor
0049   Standard_EXPORT void Init (const Handle(IGESBasic_SubfigureDef)& aSubfigureDef, const gp_XYZ& aTranslation, const Standard_Boolean hasScale, const Standard_Real aScale);
0050
0051   //! returns the subfigure definition entity
0052   Standard_EXPORT Handle(IGESBasic_SubfigureDef) Subfigure() const;
0053
0054   //! returns the X, Y, Z coordinates
0055   Standard_EXPORT gp_XYZ Translation() const;
0056
0057   //! returns the scale factor
0058   //! if hasScaleFactor is False, returns 1.0 (default)
0059   Standard_EXPORT Standard_Real ScaleFactor() const;
0060
0061   //! returns a boolean indicating whether scale factor
0062   //! is present or not
0063   Standard_EXPORT Standard_Boolean HasScaleFactor() const;
0064
0065   //! returns the Translation after transformation
0066   Standard_EXPORT gp_XYZ TransformedTranslation() const;
0067
0068
0069
0070
0071   DEFINE_STANDARD_RTTIEXT(IGESBasic_SingularSubfigure,IGESData_IGESEntity)
0072
0073 protected:
0074
0075
0076
0077
0078 private:
0079
0080
0081   Handle(IGESBasic_SubfigureDef) theSubfigureDef;
0082   gp_XYZ theTranslation;
0083   Standard_Real theScaleFactor;
0084   Standard_Boolean hasScaleFactor;
0085
0086
0087 };
0088
0089
0090
0091
0092
0093
0094
0095 #endif // _IGESBasic_SingularSubfigure_HeaderFile