include/opencascade/IGESGraph_TextDisplayTemplate.hxx

0001 // Created on: 1993-01-11
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 _IGESGraph_TextDisplayTemplate_HeaderFile
0018 #define _IGESGraph_TextDisplayTemplate_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <gp_XYZ.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 class IGESGraph_TextFontDef;
0027 class gp_Pnt;
0028
0029 //! defines IGES TextDisplayTemplate Entity,
0030 //! Type <312>, form <0, 1> in package IGESGraph
0031 //!
0032 //! Used to set parameters for display of information
0033 //! which has been logically included in another entity
0034 //! as a parameter value
0035 class IGESGraph_TextDisplayTemplate : public IGESData_IGESEntity
0036 {
0037
0038 public:
0039   Standard_EXPORT IGESGraph_TextDisplayTemplate();
0040
0041   //! This method is used to set the fields of the class
0042   //! TextDisplayTemplate
0043   //! - aWidth         : Character box width
0044   //! - aHeight        : Character box height
0045   //! - afontCode      : Font code
0046   //! - aFontEntity    : Text Font Definition Entity
0047   //! - aSlantAngle    : Slant angle
0048   //! - aRotationAngle : Rotation angle
0049   //! - aMirrorFlag    : Mirror Flag
0050   //! - aRotationFlag  : Rotate internal text flag
0051   //! - aCorner        : Lower left corner coordinates(Form No. 0),
0052   //! Increments from coordinates (Form No. 1)
0053   Standard_EXPORT void Init(const double                              aWidth,
0054                             const double                              aHeight,
0055                             const int                                 aFontCode,
0056                             const occ::handle<IGESGraph_TextFontDef>& aFontEntity,
0057                             const double                              aSlantAngle,
0058                             const double                              aRotationAngle,
0059                             const int                                 aMirrorFlag,
0060                             const int                                 aRotationFlag,
0061                             const gp_XYZ&                             aCorner);
0062
0063   //! Sets <me> to be Incremental (Form 1) if <mode> is True,
0064   //! or Basolute (Form 0) else
0065   Standard_EXPORT void SetIncremental(const bool mode);
0066
0067   //! returns True if entity is Incremental (Form 1).
0068   //! False if entity is Absolute (Form 0).
0069   Standard_EXPORT bool IsIncremental() const;
0070
0071   //! returns Character Box Width.
0072   Standard_EXPORT double BoxWidth() const;
0073
0074   //! returns Character Box Height.
0075   Standard_EXPORT double BoxHeight() const;
0076
0077   //! returns False if theFontEntity is Null, True otherwise.
0078   Standard_EXPORT bool IsFontEntity() const;
0079
0080   //! returns the font code.
0081   Standard_EXPORT int FontCode() const;
0082
0083   //! returns Text Font Definition Entity used to define the font.
0084   Standard_EXPORT occ::handle<IGESGraph_TextFontDef> FontEntity() const;
0085
0086   //! returns slant angle of character in radians.
0087   Standard_EXPORT double SlantAngle() const;
0088
0089   //! returns Rotation angle of text block in radians.
0090   Standard_EXPORT double RotationAngle() const;
0091
0092   //! returns Mirror flag
0093   //! Mirror flag : 0 = no mirroring.
0094   //! 1 = mirror axis perpendicular to text base line.
0095   //! 2 = mirror axis is text base line.
0096   Standard_EXPORT int MirrorFlag() const;
0097
0098   //! returns Rotate internal text flag.
0099   //! Rotate internal text flag : 0 = text horizontal.
0100   //! 1 = text vertical.
0101   Standard_EXPORT int RotateFlag() const;
0102
0103   //! If IsIncremental() returns False,
0104   //! gets coordinates of lower left corner
0105   //! of first character box.
0106   //! If IsIncremental() returns True,
0107   //! gets increments from X, Y, Z coordinates
0108   //! found in parent entity.
0109   Standard_EXPORT gp_Pnt StartingCorner() const;
0110
0111   //! If IsIncremental() returns False,
0112   //! gets coordinates of lower left corner
0113   //! of first character box.
0114   //! If IsIncremental() returns True,
0115   //! gets increments from X, Y, Z coordinates
0116   //! found in parent entity.
0117   Standard_EXPORT gp_Pnt TransformedStartingCorner() const;
0118
0119   DEFINE_STANDARD_RTTIEXT(IGESGraph_TextDisplayTemplate, IGESData_IGESEntity)
0120
0121 private:
0122   double                             theBoxWidth;
0123   double                             theBoxHeight;
0124   int                                theFontCode;
0125   occ::handle<IGESGraph_TextFontDef> theFontEntity;
0126   double                             theSlantAngle;
0127   double                             theRotationAngle;
0128   int                                theMirrorFlag;
0129   int                                theRotateFlag;
0130   gp_XYZ                             theCorner;
0131 };
0132
0133 #endif // _IGESGraph_TextDisplayTemplate_HeaderFile