include/opencascade/VrmlConverter_ShadingAspect.hxx

0001 // Created on: 1997-03-12
0002 // Created by: Alexander BRIVIN
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 _VrmlConverter_ShadingAspect_HeaderFile
0018 #define _VrmlConverter_ShadingAspect_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Vrml_ShapeHints.hxx>
0024 #include <Standard_Transient.hxx>
0025 class Vrml_Material;
0026
0027
0028 class VrmlConverter_ShadingAspect;
0029 DEFINE_STANDARD_HANDLE(VrmlConverter_ShadingAspect, Standard_Transient)
0030
0031 //! qualifies the aspect properties for
0032 //! the VRML conversation of ShadedShape .
0033 class VrmlConverter_ShadingAspect : public Standard_Transient
0034 {
0035
0036 public:
0037
0038
0039   //! create a default ShadingAspect.
0040   Standard_EXPORT VrmlConverter_ShadingAspect();
0041
0042   Standard_EXPORT void SetFrontMaterial (const Handle(Vrml_Material)& aMaterial);
0043
0044   Standard_EXPORT Handle(Vrml_Material) FrontMaterial() const;
0045
0046   Standard_EXPORT void SetShapeHints (const Vrml_ShapeHints& aShapeHints);
0047
0048   Standard_EXPORT Vrml_ShapeHints ShapeHints() const;
0049
0050   //! defines necessary of  a  calculation  of  normals for  ShadedShape  to  more
0051   //! accurately  display  curved  surfaces,  pacticularly  when  smoooth  or  phong
0052   //! shading  is  used  in  VRML  viewer.
0053   //! By default False  -  the normals are not calculated,
0054   //! True  -  the normals are calculated.
0055   //! Warning: If  normals  are  calculated  the  resulting  VRML  file  will
0056   //! be  substantially  lager.
0057   Standard_EXPORT void SetHasNormals (const Standard_Boolean OnOff);
0058
0059   //! returns True if the normals are calculating
0060   Standard_EXPORT Standard_Boolean HasNormals() const;
0061
0062   //! defines necessary of writing  Material from Vrml into  output  OStream.
0063   //! By default False  -  the material is not writing into OStream,
0064   //! True  -  the material is writing.
0065   Standard_EXPORT void SetHasMaterial (const Standard_Boolean OnOff);
0066
0067   //! returns True if the  materials is  writing into OStream.
0068   Standard_EXPORT Standard_Boolean HasMaterial() const;
0069
0070
0071
0072
0073   DEFINE_STANDARD_RTTIEXT(VrmlConverter_ShadingAspect,Standard_Transient)
0074
0075 protected:
0076
0077
0078
0079
0080 private:
0081
0082
0083   Handle(Vrml_Material) myFrontMaterial;
0084   Vrml_ShapeHints myShapeHints;
0085   Standard_Boolean myHasNormals;
0086   Standard_Boolean myHasMaterial;
0087
0088
0089 };
0090
0091
0092
0093
0094
0095
0096
0097 #endif // _VrmlConverter_ShadingAspect_HeaderFile