include/opencascade/IGESGraph_HighLight.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( TCD )
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_HighLight_HeaderFile
0018 #define _IGESGraph_HighLight_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024
0025 //! defines IGESHighLight, Type <406> Form <20>
0026 //! in package IGESGraph
0027 //!
0028 //! Attaches information that an entity is to be
0029 //! displayed in some system dependent manner
0030 class IGESGraph_HighLight : public IGESData_IGESEntity
0031 {
0032
0033 public:
0034   Standard_EXPORT IGESGraph_HighLight();
0035
0036   //! This method is used to set the fields of the class
0037   //! HighLight
0038   //! - nbProps          : Number of property values (NP = 1)
0039   //! - aHighLightStatus : HighLight Flag
0040   Standard_EXPORT void Init(const int nbProps, const int aHighLightStatus);
0041
0042   //! returns the number of property values in <me>
0043   Standard_EXPORT int NbPropertyValues() const;
0044
0045   //! returns 0 if <me> is not highlighted(default),
0046   //! 1 if <me> is highlighted
0047   Standard_EXPORT int HighLightStatus() const;
0048
0049   //! returns True if entity is highlighted
0050   Standard_EXPORT bool IsHighLighted() const;
0051
0052   DEFINE_STANDARD_RTTIEXT(IGESGraph_HighLight, IGESData_IGESEntity)
0053
0054 private:
0055   int theNbPropertyValues;
0056   int theHighLight;
0057 };
0058
0059 #endif // _IGESGraph_HighLight_HeaderFile