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
0028 class IGESGraph_LineFontDefTemplate;
0029 DEFINE_STANDARD_HANDLE(IGESGraph_LineFontDefTemplate, IGESData_LineFontEntity)
0030
0031 //! defines IGESLineFontDefTemplate, Type <304> Form <1>
0032 //! in package IGESGraph
0033 //!
0034 //! Line Font can be defined as a repetition od Template figure
0035 //! that is displayed at regularly spaced locations along a
0036 //! planer anchoring curve. The anchoring curve itself has
0037 //! no visual purpose.
0038 class IGESGraph_LineFontDefTemplate : public IGESData_LineFontEntity
0039 {
0040
0041 public:
0042
0043
0044   Standard_EXPORT IGESGraph_LineFontDefTemplate();
0045
0046   //! This method is used to set the fields of the class
0047   //! LineFontDefTemplate
0048   //! - anOrientation : Orientation of Template figure on
0049   //! anchoring curve
0050   //! - aTemplate     : SubfigureDef entity used as Template figure
0051   //! - aDistance     : Distance between the neighbouring Template
0052   //! figures
0053   //! - aScale        : Scale factor applied to the Template figure
0054   Standard_EXPORT void Init (const Standard_Integer anOrientation, const Handle(IGESBasic_SubfigureDef)& aTemplate, const Standard_Real aDistance, const Standard_Real aScale);
0055
0056   //! if return value = 0, Each Template display is oriented by aligning
0057   //! the axis of the SubfigureDef with the axis of
0058   //! the definition space of the anchoring curve.
0059   //! = 1, Each Template display is oriented by aligning
0060   //! X-axis of the SubfigureDef with the tangent
0061   //! vector of the anchoring curve at the point of
0062   //! incidence of the curve and the origin of
0063   //! subfigure.
0064   //! Similarly Z-axis is aligned.
0065   Standard_EXPORT Standard_Integer Orientation() const;
0066
0067   //! returns SubfigureDef as the Entity used as Template figure.
0068   Standard_EXPORT Handle(IGESBasic_SubfigureDef) TemplateEntity() const;
0069
0070   //! returns the Distance between any two Template figures on the
0071   //! anchoring curve.
0072   Standard_EXPORT Standard_Real Distance() const;
0073
0074   //! returns the Scaling factor applied to SubfigureDef to form
0075   //! Template figure.
0076   Standard_EXPORT Standard_Real Scale() const;
0077
0078
0079
0080
0081   DEFINE_STANDARD_RTTIEXT(IGESGraph_LineFontDefTemplate,IGESData_LineFontEntity)
0082
0083 protected:
0084
0085
0086
0087
0088 private:
0089
0090
0091   Standard_Integer theOrientation;
0092   Handle(IGESBasic_SubfigureDef) theTemplateEntity;
0093   Standard_Real theDistance;
0094   Standard_Real theScale;
0095
0096
0097 };
0098
0099
0100
0101
0102
0103
0104
0105 #endif // _IGESGraph_LineFontDefTemplate_HeaderFile