src/IGESGraph/IGESGraph_HighLight.hxx

   1 // Created on: 1993-01-09
   2 // Created by: CKY / Contract Toubro-Larsen ( TCD )
   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_HighLight_HeaderFile
  18 #define _IGESGraph_HighLight_HeaderFile
  19
  20 #include <Standard.hxx>
  21
  22 #include <Standard_Integer.hxx>
  23 #include <IGESData_IGESEntity.hxx>
  24
  25
  26 class IGESGraph_HighLight;
  27 DEFINE_STANDARD_HANDLE(IGESGraph_HighLight, IGESData_IGESEntity)
  28
  29 //! defines IGESHighLight, Type <406> Form <20>
  30 //! in package IGESGraph
  31 //!
  32 //! Attaches information that an entity is to be
  33 //! displayed in some system dependent manner
  34 class IGESGraph_HighLight : public IGESData_IGESEntity
  35 {
  36
  37 public:
  38
  39
  40   Standard_EXPORT IGESGraph_HighLight();
  41
  42   //! This method is used to set the fields of the class
  43   //! HighLight
  44   //! - nbProps          : Number of property values (NP = 1)
  45   //! - aHighLightStatus : HighLight Flag
  46   Standard_EXPORT void Init (const Standard_Integer nbProps, const Standard_Integer aHighLightStatus);
  47
  48   //! returns the number of property values in <me>
  49   Standard_EXPORT Standard_Integer NbPropertyValues() const;
  50
  51   //! returns 0 if <me> is not highlighted(default),
  52   //! 1 if <me> is highlighted
  53   Standard_EXPORT Standard_Integer HighLightStatus() const;
  54
  55   //! returns True if entity is highlighted
  56   Standard_EXPORT Standard_Boolean IsHighLighted() const;
  57
  58
  59
  60
  61   DEFINE_STANDARD_RTTIEXT(IGESGraph_HighLight,IGESData_IGESEntity)
  62
  63 protected:
  64
  65
  66
  67
  68 private:
  69
  70
  71   Standard_Integer theNbPropertyValues;
  72   Standard_Integer theHighLight;
  73
  74
  75 };
  76
  77
  78
  79
  80
  81
  82
  83 #endif // _IGESGraph_HighLight_HeaderFile