include/opencascade/IGESGeom_Flash.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( TCD )
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_Flash_HeaderFile
0018 #define _IGESGeom_Flash_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XY.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 #include <Standard_Integer.hxx>
0026 class gp_Pnt2d;
0027 class gp_Pnt;
0028
0029
0030 class IGESGeom_Flash;
0031 DEFINE_STANDARD_HANDLE(IGESGeom_Flash, IGESData_IGESEntity)
0032
0033 //! defines IGESFlash, Type <125> Form <0 - 4>
0034 //! in package IGESGeom
0035 //! A flash entity is a point in the ZT=0 plane that locates
0036 //! a particular closed area. That closed area can be defined
0037 //! in one of two ways. First, it can be an arbitrary closed
0038 //! area defined by any entity capable of defining a closed
0039 //! area. The points of this entity must all lie in the ZT=0
0040 //! plane. Second, it can be a member of a predefined set of
0041 //! flash shapes.
0042 class IGESGeom_Flash : public IGESData_IGESEntity
0043 {
0044
0045 public:
0046
0047
0048   Standard_EXPORT IGESGeom_Flash();
0049
0050   //! This method is used to set the fields of the class Flash
0051   //! - aPoint     : Reference of flash
0052   //! - aDim       : First flash sizing parameter
0053   //! - anotherDim : Second flash sizing parameter
0054   //! - aRotation  : Rotation of flash about reference point
0055   //! in radians
0056   //! - aReference : Pointer to the referenced entity or Null
0057   Standard_EXPORT void Init (const gp_XY& aPoint, const Standard_Real aDim, const Standard_Real anotherDim, const Standard_Real aRotation, const Handle(IGESData_IGESEntity)& aReference);
0058
0059   //! Changes FormNumber (indicates the Nature of the Flash :
0060   //! 0 Unspecified, then given by Reference, 1->4 various
0061   //! Specialisations (Circle,Rectangle, etc...) )
0062   //! Error if not in range [0-4]
0063   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
0064
0065   //! returns the referenced point, Z = 0 always
0066   Standard_EXPORT gp_Pnt2d ReferencePoint() const;
0067
0068   //! returns the referenced point after applying Transf. Matrix
0069   Standard_EXPORT gp_Pnt TransformedReferencePoint() const;
0070
0071   //! returns first flash sizing parameter
0072   Standard_EXPORT Standard_Real Dimension1() const;
0073
0074   //! returns second flash sizing parameter
0075   Standard_EXPORT Standard_Real Dimension2() const;
0076
0077   //! returns the angle in radians of the rotation of flash about the
0078   //! reference point
0079   Standard_EXPORT Standard_Real Rotation() const;
0080
0081   //! returns the referenced entity or Null handle.
0082   Standard_EXPORT Handle(IGESData_IGESEntity) ReferenceEntity() const;
0083
0084   //! returns True if referenced entity is present.
0085   Standard_EXPORT Standard_Boolean HasReferenceEntity() const;
0086
0087
0088
0089
0090   DEFINE_STANDARD_RTTIEXT(IGESGeom_Flash,IGESData_IGESEntity)
0091
0092 protected:
0093
0094
0095
0096
0097 private:
0098
0099
0100   gp_XY thePoint;
0101   Standard_Real theDim1;
0102   Standard_Real theDim2;
0103   Standard_Real theRotation;
0104   Handle(IGESData_IGESEntity) theReference;
0105
0106
0107 };
0108
0109
0110
0111
0112
0113
0114
0115 #endif // _IGESGeom_Flash_HeaderFile