summaryrefslogtreecommitdiff
path: root/inc/Aspect_GenericColorMap.hxx
blob: c89144550666a8a5686f20708ab6aafd49e43f2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _Aspect_GenericColorMap_HeaderFile
#define _Aspect_GenericColorMap_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_Aspect_GenericColorMap_HeaderFile
#include <Handle_Aspect_GenericColorMap.hxx>
#endif

#ifndef _TColStd_DataMapOfIntegerInteger_HeaderFile
#include <TColStd_DataMapOfIntegerInteger.hxx>
#endif
#ifndef _Aspect_ColorMap_HeaderFile
#include <Aspect_ColorMap.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
class Aspect_BadAccess;
class Aspect_ColorMapEntry;
class Quantity_Color;


//! This class defines a GenericColorMap object. <br>
class Aspect_GenericColorMap : public Aspect_ColorMap {

public:

  //! Creates a generic ColorMap . <br>
  Standard_EXPORT   Aspect_GenericColorMap();
  //! Adds an entry in the color map <me>. <br>
//!  Warning: Raises BadAccess if the ColorMapEntry index is alreadry <br>
//!          defined. <br>
  Standard_EXPORT     void AddEntry(const Aspect_ColorMapEntry& AnEntry) ;
  //! Search an identical color entry in the color map <me> <br>
//! and returns the ColorMapEntry Index if exist. <br>
//! Or add a new entry and returns the computed ColorMapEntry index used. <br>
  Standard_EXPORT     Standard_Integer AddEntry(const Quantity_Color& aColor) ;
  //! Remove the ColorMapEntry at position index in the ColorMap <br>
//!  Warning: Raises BadAccess if the index is not defined in the <br>
//!	    ColorMap. <br>
  Standard_EXPORT     void RemoveEntry(const Standard_Integer AColorMapEntryIndex) ;
  //! Returns the index in the ColorMap of the <br>
//!	    ColorMapEntry.Index() equal to <AnEntryIndex>. <br>
//!  Warning: Raises BadAccess if the index is not defined in the <br>
//!	    ColorMap. <br>
  Standard_EXPORT     Standard_Integer FindColorMapIndex(const Standard_Integer AColorMapEntryIndex) const;
  //! Returns the ColorMapEntry with ColorMapEntry.Index() <br>
//!	    equal to <AnEntryIndex>. <br>
//!  Warning: Raises BadAccess if the index is not defined in the <br>
//!	    ColorMap. <br>
  Standard_EXPORT    const Aspect_ColorMapEntry& FindEntry(const Standard_Integer AColorMapEntryIndex) const;
  //! Returns the index in the ColorMap of the <br>
//!	    nearest matching ColorMapEntry <br>
  Standard_EXPORT     Standard_Integer NearestColorMapIndex(const Quantity_Color& aColor) const;
  //! Returns the nearest ColorMapEntry that match aColor . <br>
  Standard_EXPORT    const Aspect_ColorMapEntry& NearestEntry(const Quantity_Color& aColor) const;




  DEFINE_STANDARD_RTTI(Aspect_GenericColorMap)

protected:


TColStd_DataMapOfIntegerInteger myDataMap;


private: 




};





// other Inline functions and methods (like "C++: function call" methods)


#endif