include/opencascade/XCAFDoc_Color.hxx

0001 // Created on: 2000-08-16
0002 // Created by: data exchange team
0003 // Copyright (c) 2000-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _XCAFDoc_Color_HeaderFile
0017 #define _XCAFDoc_Color_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <Quantity_ColorRGBA.hxx>
0022 #include <TDF_Attribute.hxx>
0023 #include <Quantity_NameOfColor.hxx>
0024 class Standard_GUID;
0025 class TDF_Label;
0026 class Quantity_Color;
0027 class TDF_RelocationTable;
0028
0029 class XCAFDoc_Color;
0030 DEFINE_STANDARD_HANDLE(XCAFDoc_Color, TDF_Attribute)
0031
0032 //! attribute to store color
0033 class XCAFDoc_Color : public TDF_Attribute
0034 {
0035
0036 public:
0037   Standard_EXPORT XCAFDoc_Color();
0038
0039   Standard_EXPORT static const Standard_GUID& GetID();
0040
0041   Standard_EXPORT static Handle(XCAFDoc_Color) Set(const TDF_Label& label, const Quantity_Color& C);
0042
0043   Standard_EXPORT static Handle(XCAFDoc_Color) Set(const TDF_Label&          label,
0044                                                    const Quantity_ColorRGBA& C);
0045
0046   Standard_EXPORT static Handle(XCAFDoc_Color) Set(const TDF_Label&           label,
0047                                                    const Quantity_NameOfColor C);
0048
0049   //! Find, or create, a Color attribute and set it's value
0050   //! the Color attribute is returned.
0051   Standard_EXPORT static Handle(XCAFDoc_Color) Set(const TDF_Label&    label,
0052                                                    const Standard_Real R,
0053                                                    const Standard_Real G,
0054                                                    const Standard_Real B,
0055                                                    const Standard_Real alpha = 1.0);
0056
0057   Standard_EXPORT void Set(const Quantity_Color& C);
0058
0059   Standard_EXPORT void Set(const Quantity_ColorRGBA& C);
0060
0061   Standard_EXPORT void Set(const Quantity_NameOfColor C);
0062
0063   Standard_EXPORT void Set(const Standard_Real R,
0064                            const Standard_Real G,
0065                            const Standard_Real B,
0066                            const Standard_Real alpha = 1.0);
0067
0068   Standard_EXPORT const Quantity_Color& GetColor() const;
0069
0070   Standard_EXPORT const Quantity_ColorRGBA& GetColorRGBA() const;
0071
0072   Standard_EXPORT Quantity_NameOfColor GetNOC() const;
0073
0074   Standard_EXPORT void GetRGB(Standard_Real& R, Standard_Real& G, Standard_Real& B) const;
0075
0076   Standard_EXPORT Standard_ShortReal GetAlpha() const;
0077
0078   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0079
0080   Standard_EXPORT void Restore(const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0081
0082   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0083
0084   Standard_EXPORT void Paste(const Handle(TDF_Attribute)&       Into,
0085                              const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0086
0087   //! Dumps the content of me into the stream
0088   Standard_EXPORT virtual void DumpJson(Standard_OStream& theOStream,
0089                                         Standard_Integer  theDepth = -1) const Standard_OVERRIDE;
0090
0091   DEFINE_STANDARD_RTTIEXT(XCAFDoc_Color, TDF_Attribute)
0092
0093 protected:
0094 private:
0095   Quantity_ColorRGBA myColor;
0096 };
0097
0098 #endif // _XCAFDoc_Color_HeaderFile