src/IGESGraph/IGESGraph_LineFontDefTemplate.hxx

   1 // Created on: 1993-01-11
   2 // Created by: CKY / Contract Toubro-Larsen ( Niraj RANGWALA )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESGraph_LineFontDefTemplate_HeaderFile
  18 #define _IGESGraph_LineFontDefTemplate_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <Standard_Integer.hxx>
  24 #include <Standard_Real.hxx>
  25 #include <IGESData_LineFontEntity.hxx>
  26 class IGESBasic_SubfigureDef;
  27
  28
  29 class IGESGraph_LineFontDefTemplate;
  30 DEFINE_STANDARD_HANDLE(IGESGraph_LineFontDefTemplate, IGESData_LineFontEntity)
  31
  32 //! defines IGESLineFontDefTemplate, Type <304> Form <1>
  33 //! in package IGESGraph
  34 //!
  35 //! Line Font can be defined as a repetition od Template figure
  36 //! that is displayed at regularly spaced locations along a
  37 //! planer anchoring curve. The anchoring curve itself has
  38 //! no visual purpose.
  39 class IGESGraph_LineFontDefTemplate : public IGESData_LineFontEntity
  40 {
  41
  42 public:
  43
  44
  45   Standard_EXPORT IGESGraph_LineFontDefTemplate();
  46
  47   //! This method is used to set the fields of the class
  48   //! LineFontDefTemplate
  49   //! - anOrientation : Orientation of Template figure on
  50   //! anchoring curve
  51   //! - aTemplate     : SubfigureDef entity used as Template figure
  52   //! - aDistance     : Distance between the neighbouring Template
  53   //! figures
  54   //! - aScale        : Scale factor applied to the Template figure
  55   Standard_EXPORT void Init (const Standard_Integer anOrientation, const Handle(IGESBasic_SubfigureDef)& aTemplate, const Standard_Real aDistance, const Standard_Real aScale);
  56
  57   //! if return value = 0, Each Template display is oriented by aligning
  58   //! the axis of the SubfigureDef with the axis of
  59   //! the definition space of the anchoring curve.
  60   //! = 1, Each Template display is oriented by aligning
  61   //! X-axis of the SubfigureDef with the tangent
  62   //! vector of the anchoring curve at the point of
  63   //! incidence of the curve and the origin of
  64   //! subfigure.
  65   //! Similarly Z-axis is aligned.
  66   Standard_EXPORT Standard_Integer Orientation() const;
  67
  68   //! returns SubfigureDef as the Entity used as Template figure.
  69   Standard_EXPORT Handle(IGESBasic_SubfigureDef) TemplateEntity() const;
  70
  71   //! returns the Distance between any two Template figures on the
  72   //! anchoring curve.
  73   Standard_EXPORT Standard_Real Distance() const;
  74
  75   //! returns the Scaling factor applied to SubfigureDef to form
  76   //! Template figure.
  77   Standard_EXPORT Standard_Real Scale() const;
  78
  79
  80
  81
  82   DEFINE_STANDARD_RTTIEXT(IGESGraph_LineFontDefTemplate,IGESData_LineFontEntity)
  83
  84 protected:
  85
  86
  87
  88
  89 private:
  90
  91
  92   Standard_Integer theOrientation;
  93   Handle(IGESBasic_SubfigureDef) theTemplateEntity;
  94   Standard_Real theDistance;
  95   Standard_Real theScale;
  96
  97
  98 };
  99
 100
 101
 102
 103
 104
 105
 106 #endif // _IGESGraph_LineFontDefTemplate_HeaderFile