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
0030 class XCAFDoc_Color;
0031 DEFINE_STANDARD_HANDLE(XCAFDoc_Color, TDF_Attribute)
0032
0033 //! attribute to store color
0034 class XCAFDoc_Color : public TDF_Attribute
0035 {
0036
0037 public:
0038
0039
0040   Standard_EXPORT XCAFDoc_Color();
0041
0042   Standard_EXPORT static const Standard_GUID& GetID();
0043
0044   Standard_EXPORT static Handle(XCAFDoc_Color) Set (const TDF_Label& label, const Quantity_Color& C);
0045
0046   Standard_EXPORT static Handle(XCAFDoc_Color) Set (const TDF_Label& label, const Quantity_ColorRGBA& C);
0047
0048   Standard_EXPORT static Handle(XCAFDoc_Color) Set (const TDF_Label& label, const Quantity_NameOfColor C);
0049
0050   //! Find, or create, a Color attribute and set it's value
0051   //! the Color attribute is returned.
0052   Standard_EXPORT static Handle(XCAFDoc_Color) Set (const TDF_Label& label, const Standard_Real R, const Standard_Real G, const Standard_Real B, const Standard_Real alpha = 1.0);
0053
0054   Standard_EXPORT void Set (const Quantity_Color& C);
0055
0056   Standard_EXPORT void Set (const Quantity_ColorRGBA& C);
0057
0058   Standard_EXPORT void Set (const Quantity_NameOfColor C);
0059
0060   Standard_EXPORT void Set (const Standard_Real R, const Standard_Real G, const Standard_Real B, const Standard_Real alpha = 1.0);
0061
0062   Standard_EXPORT const Quantity_Color& GetColor() const;
0063
0064   Standard_EXPORT const Quantity_ColorRGBA& GetColorRGBA() const;
0065
0066   Standard_EXPORT Quantity_NameOfColor GetNOC() const;
0067
0068   Standard_EXPORT void GetRGB (Standard_Real& R, Standard_Real& G, Standard_Real& B) const;
0069
0070   Standard_EXPORT Standard_ShortReal GetAlpha() const;
0071
0072   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0073
0074   Standard_EXPORT void Restore (const Handle(TDF_Attribute)& With) Standard_OVERRIDE;
0075
0076   Standard_EXPORT Handle(TDF_Attribute) NewEmpty() const Standard_OVERRIDE;
0077
0078   Standard_EXPORT void Paste (const Handle(TDF_Attribute)& Into, const Handle(TDF_RelocationTable)& RT) const Standard_OVERRIDE;
0079
0080   //! Dumps the content of me into the stream
0081   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0082
0083
0084
0085
0086   DEFINE_STANDARD_RTTIEXT(XCAFDoc_Color,TDF_Attribute)
0087
0088 protected:
0089
0090
0091
0092
0093 private:
0094
0095
0096   Quantity_ColorRGBA myColor;
0097
0098
0099 };
0100
0101
0102
0103
0104
0105
0106
0107 #endif // _XCAFDoc_Color_HeaderFile