include/opencascade/IGESGraph_LineFontDefTemplate.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Niraj RANGWALA )
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_LineFontDefTemplate_HeaderFile
0018 #define _IGESGraph_LineFontDefTemplate_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <IGESData_LineFontEntity.hxx>
0025 class IGESBasic_SubfigureDef;
0026
0027 //! defines IGESLineFontDefTemplate, Type <304> Form <1>
0028 //! in package IGESGraph
0029 //!
0030 //! Line Font can be defined as a repetition of Template figure
0031 //! that is displayed at regularly spaced locations along a
0032 //! planer anchoring curve. The anchoring curve itself has
0033 //! no visual purpose.
0034 class IGESGraph_LineFontDefTemplate : public IGESData_LineFontEntity
0035 {
0036
0037 public:
0038   Standard_EXPORT IGESGraph_LineFontDefTemplate();
0039
0040   //! This method is used to set the fields of the class
0041   //! LineFontDefTemplate
0042   //! - anOrientation : Orientation of Template figure on
0043   //! anchoring curve
0044   //! - aTemplate     : SubfigureDef entity used as Template figure
0045   //! - aDistance     : Distance between the neighbouring Template
0046   //! figures
0047   //! - aScale        : Scale factor applied to the Template figure
0048   Standard_EXPORT void Init(const int                                  anOrientation,
0049                             const occ::handle<IGESBasic_SubfigureDef>& aTemplate,
0050                             const double                               aDistance,
0051                             const double                               aScale);
0052
0053   //! if return value = 0, Each Template display is oriented by aligning
0054   //! the axis of the SubfigureDef with the axis of
0055   //! the definition space of the anchoring curve.
0056   //! = 1, Each Template display is oriented by aligning
0057   //! X-axis of the SubfigureDef with the tangent
0058   //! vector of the anchoring curve at the point of
0059   //! incidence of the curve and the origin of
0060   //! subfigure.
0061   //! Similarly Z-axis is aligned.
0062   Standard_EXPORT int Orientation() const;
0063
0064   //! returns SubfigureDef as the Entity used as Template figure.
0065   Standard_EXPORT occ::handle<IGESBasic_SubfigureDef> TemplateEntity() const;
0066
0067   //! returns the Distance between any two Template figures on the
0068   //! anchoring curve.
0069   Standard_EXPORT double Distance() const;
0070
0071   //! returns the Scaling factor applied to SubfigureDef to form
0072   //! Template figure.
0073   Standard_EXPORT double Scale() const;
0074
0075   DEFINE_STANDARD_RTTIEXT(IGESGraph_LineFontDefTemplate, IGESData_LineFontEntity)
0076
0077 private:
0078   int                                 theOrientation;
0079   occ::handle<IGESBasic_SubfigureDef> theTemplateEntity;
0080   double                              theDistance;
0081   double                              theScale;
0082 };
0083
0084 #endif // _IGESGraph_LineFontDefTemplate_HeaderFile