include/opencascade/Vrml_Material.hxx

0001 // Created on: 1997-02-10
0002 // Created by: Alexander BRIVIN and Dmitry TARASOV
0003 // Copyright (c) 1997-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 _Vrml_Material_HeaderFile
0018 #define _Vrml_Material_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Quantity_Color.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <NCollection_HArray1.hxx>
0026 #include <Standard_Transient.hxx>
0027 #include <Standard_OStream.hxx>
0028
0029 //! defines a Material node of VRML specifying properties of geometry
0030 //! and its appearance.
0031 //! This node defines the current surface material properties for all subsequent shapes.
0032 //! Material sets several components of the current material during traversal. Different shapes
0033 //! interpret materials with multiple values differently. To bind materials to shapes, use a
0034 //! MaterialBinding node.
0035 class Vrml_Material : public Standard_Transient
0036 {
0037
0038 public:
0039   Standard_EXPORT Vrml_Material(
0040     const occ::handle<NCollection_HArray1<Quantity_Color>>& aAmbientColor,
0041     const occ::handle<NCollection_HArray1<Quantity_Color>>& aDiffuseColor,
0042     const occ::handle<NCollection_HArray1<Quantity_Color>>& aSpecularColor,
0043     const occ::handle<NCollection_HArray1<Quantity_Color>>& aEmissiveColor,
0044     const occ::handle<NCollection_HArray1<double>>&         aShininess,
0045     const occ::handle<NCollection_HArray1<double>>&         aTransparency);
0046
0047   Standard_EXPORT Vrml_Material();
0048
0049   Standard_EXPORT void SetAmbientColor(
0050     const occ::handle<NCollection_HArray1<Quantity_Color>>& aAmbientColor);
0051
0052   Standard_EXPORT occ::handle<NCollection_HArray1<Quantity_Color>> AmbientColor() const;
0053
0054   Standard_EXPORT void SetDiffuseColor(
0055     const occ::handle<NCollection_HArray1<Quantity_Color>>& aDiffuseColor);
0056
0057   Standard_EXPORT occ::handle<NCollection_HArray1<Quantity_Color>> DiffuseColor() const;
0058
0059   Standard_EXPORT void SetSpecularColor(
0060     const occ::handle<NCollection_HArray1<Quantity_Color>>& aSpecularColor);
0061
0062   Standard_EXPORT occ::handle<NCollection_HArray1<Quantity_Color>> SpecularColor() const;
0063
0064   Standard_EXPORT void SetEmissiveColor(
0065     const occ::handle<NCollection_HArray1<Quantity_Color>>& aEmissiveColor);
0066
0067   Standard_EXPORT occ::handle<NCollection_HArray1<Quantity_Color>> EmissiveColor() const;
0068
0069   Standard_EXPORT void SetShininess(const occ::handle<NCollection_HArray1<double>>& aShininess);
0070
0071   Standard_EXPORT occ::handle<NCollection_HArray1<double>> Shininess() const;
0072
0073   Standard_EXPORT void SetTransparency(
0074     const occ::handle<NCollection_HArray1<double>>& aTransparency);
0075
0076   Standard_EXPORT occ::handle<NCollection_HArray1<double>> Transparency() const;
0077
0078   Standard_EXPORT Standard_OStream& Print(Standard_OStream& anOStream) const;
0079
0080   DEFINE_STANDARD_RTTIEXT(Vrml_Material, Standard_Transient)
0081
0082 private:
0083   occ::handle<NCollection_HArray1<Quantity_Color>> myAmbientColor;
0084   occ::handle<NCollection_HArray1<Quantity_Color>> myDiffuseColor;
0085   occ::handle<NCollection_HArray1<Quantity_Color>> mySpecularColor;
0086   occ::handle<NCollection_HArray1<Quantity_Color>> myEmissiveColor;
0087   occ::handle<NCollection_HArray1<double>>         myShininess;
0088   occ::handle<NCollection_HArray1<double>>         myTransparency;
0089 };
0090
0091 #endif // _Vrml_Material_HeaderFile