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 <IGESData_LineFontEntity.hxx>
  25 class IGESBasic_SubfigureDef;
  26
  27
  28 class IGESGraph_LineFontDefTemplate;
  29 DEFINE_STANDARD_HANDLE(IGESGraph_LineFontDefTemplate, IGESData_LineFontEntity)
  30
  31 //! defines IGESLineFontDefTemplate, Type <304> Form <1>
  32 //! in package IGESGraph
  33 //!
  34 //! Line Font can be defined as a repetition od Template figure
  35 //! that is displayed at regularly spaced locations along a
  36 //! planer anchoring curve. The anchoring curve itself has
  37 //! no visual purpose.
  38 class IGESGraph_LineFontDefTemplate : public IGESData_LineFontEntity
  39 {
  40
  41 public:
  42
  43
  44   Standard_EXPORT IGESGraph_LineFontDefTemplate();
  45
  46   //! This method is used to set the fields of the class
  47   //! LineFontDefTemplate
  48   //! - anOrientation : Orientation of Template figure on
  49   //! anchoring curve
  50   //! - aTemplate     : SubfigureDef entity used as Template figure
  51   //! - aDistance     : Distance between the neighbouring Template
  52   //! figures
  53   //! - aScale        : Scale factor applied to the Template figure
  54   Standard_EXPORT void Init (const Standard_Integer anOrientation, const Handle(IGESBasic_SubfigureDef)& aTemplate, const Standard_Real aDistance, const Standard_Real aScale);
  55
  56   //! if return value = 0, Each Template display is oriented by aligning
  57   //! the axis of the SubfigureDef with the axis of
  58   //! the definition space of the anchoring curve.
  59   //! = 1, Each Template display is oriented by aligning
  60   //! X-axis of the SubfigureDef with the tangent
  61   //! vector of the anchoring curve at the point of
  62   //! incidence of the curve and the origin of
  63   //! subfigure.
  64   //! Similarly Z-axis is aligned.
  65   Standard_EXPORT Standard_Integer Orientation() const;
  66
  67   //! returns SubfigureDef as the Entity used as Template figure.
  68   Standard_EXPORT Handle(IGESBasic_SubfigureDef) TemplateEntity() const;
  69
  70   //! returns the Distance between any two Template figures on the
  71   //! anchoring curve.
  72   Standard_EXPORT Standard_Real Distance() const;
  73
  74   //! returns the Scaling factor applied to SubfigureDef to form
  75   //! Template figure.
  76   Standard_EXPORT Standard_Real Scale() const;
  77
  78
  79
  80
  81   DEFINE_STANDARD_RTTIEXT(IGESGraph_LineFontDefTemplate,IGESData_LineFontEntity)
  82
  83 protected:
  84
  85
  86
  87
  88 private:
  89
  90
  91   Standard_Integer theOrientation;
  92   Handle(IGESBasic_SubfigureDef) theTemplateEntity;
  93   Standard_Real theDistance;
  94   Standard_Real theScale;
  95
  96
  97 };
  98
  99
 100
 101
 102
 103
 104
 105 #endif // _IGESGraph_LineFontDefTemplate_HeaderFile