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
0026 class IGESGraph_HighLight;
0027 DEFINE_STANDARD_HANDLE(IGESGraph_HighLight, IGESData_IGESEntity)
0028
0029 //! defines IGESHighLight, Type <406> Form <20>
0030 //! in package IGESGraph
0031 //!
0032 //! Attaches information that an entity is to be
0033 //! displayed in some system dependent manner
0034 class IGESGraph_HighLight : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038
0039
0040   Standard_EXPORT IGESGraph_HighLight();
0041
0042   //! This method is used to set the fields of the class
0043   //! HighLight
0044   //! - nbProps          : Number of property values (NP = 1)
0045   //! - aHighLightStatus : HighLight Flag
0046   Standard_EXPORT void Init (const Standard_Integer nbProps, const Standard_Integer aHighLightStatus);
0047
0048   //! returns the number of property values in <me>
0049   Standard_EXPORT Standard_Integer NbPropertyValues() const;
0050
0051   //! returns 0 if <me> is not highlighted(default),
0052   //! 1 if <me> is highlighted
0053   Standard_EXPORT Standard_Integer HighLightStatus() const;
0054
0055   //! returns True if entity is highlighted
0056   Standard_EXPORT Standard_Boolean IsHighLighted() const;
0057
0058
0059
0060
0061   DEFINE_STANDARD_RTTIEXT(IGESGraph_HighLight,IGESData_IGESEntity)
0062
0063 protected:
0064
0065
0066
0067
0068 private:
0069
0070
0071   Standard_Integer theNbPropertyValues;
0072   Standard_Integer theHighLight;
0073
0074
0075 };
0076
0077
0078
0079
0080
0081
0082
0083 #endif // _IGESGraph_HighLight_HeaderFile