include/opencascade/IGESGraph_Color.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Niraj RANGWALA )
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_Color_HeaderFile
0018 #define _IGESGraph_Color_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Real.hxx>
0023 #include <IGESData_ColorEntity.hxx>
0024 class TCollection_HAsciiString;
0025
0026 //! defines IGESColor, Type <314> Form <0>
0027 //! in package IGESGraph
0028 //!
0029 //! The Color Definition Entity is used to communicate the
0030 //! relationship of primary colors to the intensity level of
0031 //! the respective graphics devices as a percent of full
0032 //! intensity range.
0033 class IGESGraph_Color : public IGESData_ColorEntity
0034 {
0035
0036 public:
0037   Standard_EXPORT IGESGraph_Color();
0038
0039   //! This method is used to set the fields of the class Color
0040   //! - red        : Red   color intensity (range 0.0 to 100.0)
0041   //! - green      : Green color intensity (range 0.0 to 100.0)
0042   //! - blue       : Blue  color intensity (range 0.0 to 100.0)
0043   //! - aColorName : Name of the color (optional)
0044   Standard_EXPORT void Init(const double                                 red,
0045                             const double                                 green,
0046                             const double                                 blue,
0047                             const occ::handle<TCollection_HAsciiString>& aColorName);
0048
0049   Standard_EXPORT void RGBIntensity(double& Red, double& Green, double& Blue) const;
0050
0051   Standard_EXPORT void CMYIntensity(double& Cyan, double& Magenta, double& Yellow) const;
0052
0053   Standard_EXPORT void HLSPercentage(double& Hue, double& Lightness, double& Saturation) const;
0054
0055   //! returns True if optional character string is assigned,
0056   //! False otherwise.
0057   Standard_EXPORT bool HasColorName() const;
0058
0059   //! if HasColorName() is True returns the Verbal description of
0060   //! the Color.
0061   Standard_EXPORT occ::handle<TCollection_HAsciiString> ColorName() const;
0062
0063   DEFINE_STANDARD_RTTIEXT(IGESGraph_Color, IGESData_ColorEntity)
0064
0065 private:
0066   double                                theRed;
0067   double                                theGreen;
0068   double                                theBlue;
0069   occ::handle<TCollection_HAsciiString> theColorName;
0070 };
0071
0072 #endif // _IGESGraph_Color_HeaderFile