src/VrmlAPI/VrmlAPI_Writer.hxx

   1 // Created on: 2000-06-20
   2 // Created by: Sergey MOZOKHIN
   3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
   4 //
   5 // This file is part of Open CASCADE Technology software library.
   6 //
   7 // This library is free software; you can redistribute it and/or modify it under
   8 // the terms of the GNU Lesser General Public License version 2.1 as published
   9 // by the Free Software Foundation, with special exception defined in the file
  10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 // distribution for complete text of the license and disclaimer of any warranty.
  12 //
  13 // Alternatively, this file may be used under the terms of Open CASCADE
  14 // commercial license or contractual agreement.
  15
  16 #ifndef _VrmlAPI_Writer_HeaderFile
  17 #define _VrmlAPI_Writer_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <Standard_DefineAlloc.hxx>
  21 #include <Standard_Handle.hxx>
  22
  23 #include <VrmlAPI_RepresentationOfShape.hxx>
  24 #include <Standard_Real.hxx>
  25 #include <Quantity_HArray1OfColor.hxx>
  26 #include <Standard_CString.hxx>
  27 #include <Standard_Integer.hxx>
  28 class VrmlConverter_Drawer;
  29 class VrmlConverter_Projector;
  30 class Vrml_Material;
  31 class TopoDS_Shape;
  32
  33
  34 //! Creates and writes VRML files from Open
  35 //! CASCADE shapes. A VRML file can be written to
  36 //! an existing VRML file or to a new one.
  37 class VrmlAPI_Writer
  38 {
  39 public:
  40
  41   DEFINE_STANDARD_ALLOC
  42
  43
  44   //! Creates a writer object with default parameters.
  45   Standard_EXPORT VrmlAPI_Writer();
  46
  47   //! Resets all parameters (representation, deflection)
  48   //! to their default values..
  49   Standard_EXPORT void ResetToDefaults();
  50
  51   //! Returns drawer object
  52   Standard_EXPORT Handle(VrmlConverter_Drawer) Drawer() const;
  53
  54   //! Sets the deflection aDef of
  55   //! the mesh algorithm which is used to compute the shaded
  56   //! representation of the translated shape. The default
  57   //! value is -1. When the deflection value is less than
  58   //! 0, the deflection is calculated from the relative
  59   //! size of the shaped.
  60   Standard_EXPORT void SetDeflection (const Standard_Real aDef);
  61
  62   //! Sets the representation of the
  63   //! shape aRep which is written to the VRML file. The three options are :
  64   //! -      shaded
  65   //! -      wireframe
  66   //! -      both shaded and wireframe (default)
  67   //! defined through the VrmlAPI_RepresentationOfShape enumeration.
  68   Standard_EXPORT void SetRepresentation (const VrmlAPI_RepresentationOfShape aRep);
  69
  70   //! Set transparency to given material
  71   Standard_EXPORT void SetTransparencyToMaterial (Handle(Vrml_Material)& aMaterial, const Standard_Real aTransparency);
  72
  73   Standard_EXPORT void SetShininessToMaterial (Handle(Vrml_Material)& aMaterial, const Standard_Real aShininess);
  74
  75   Standard_EXPORT void SetAmbientColorToMaterial (Handle(Vrml_Material)& aMaterial, const Handle(Quantity_HArray1OfColor)& Color);
  76
  77   Standard_EXPORT void SetDiffuseColorToMaterial (Handle(Vrml_Material)& aMaterial, const Handle(Quantity_HArray1OfColor)& Color);
  78
  79   Standard_EXPORT void SetSpecularColorToMaterial (Handle(Vrml_Material)& aMaterial, const Handle(Quantity_HArray1OfColor)& Color);
  80
  81   Standard_EXPORT void SetEmissiveColorToMaterial (Handle(Vrml_Material)& aMaterial, const Handle(Quantity_HArray1OfColor)& Color);
  82
  83   //! Returns the representation of the shape which is
  84   //! written to the VRML file. Types of representation are set through the
  85   //! VrmlAPI_RepresentationOfShape enumeration.
  86   Standard_EXPORT VrmlAPI_RepresentationOfShape GetRepresentation() const;
  87
  88   Standard_EXPORT Handle(Vrml_Material) GetFrontMaterial() const;
  89
  90   Standard_EXPORT Handle(Vrml_Material) GetPointsMaterial() const;
  91
  92   Standard_EXPORT Handle(Vrml_Material) GetUisoMaterial() const;
  93
  94   Standard_EXPORT Handle(Vrml_Material) GetVisoMaterial() const;
  95
  96   Standard_EXPORT Handle(Vrml_Material) GetLineMaterial() const;
  97
  98   Standard_EXPORT Handle(Vrml_Material) GetWireMaterial() const;
  99
 100   Standard_EXPORT Handle(Vrml_Material) GetFreeBoundsMaterial() const;
 101
 102   Standard_EXPORT Handle(Vrml_Material) GetUnfreeBoundsMaterial() const;
 103
 104   //! Converts the shape aShape to
 105   //! VRML format of the passed version and writes it to the file identified by aFile.
 106   Standard_EXPORT void Write (const TopoDS_Shape& aShape, const Standard_CString aFile, const Standard_Integer aVersion = 2) const;
 107
 108 protected:
 109
 110   //! Converts the shape aShape to VRML format of version 1.0 and writes it
 111   //! to the file identified by aFileName using default parameters.
 112   Standard_EXPORT void write_v1 (const TopoDS_Shape& aShape, const Standard_CString aFileName) const;
 113
 114   //! Converts the shape aShape to VRML format of version 2.0 and writes it
 115   //! to the file identified by aFileName using default parameters.
 116   Standard_EXPORT void write_v2 (const TopoDS_Shape& aShape, const Standard_CString aFileName) const;
 117
 118 private:
 119
 120   VrmlAPI_RepresentationOfShape myRepresentation;
 121   Handle(VrmlConverter_Drawer) myDrawer;
 122   Standard_Real myDeflection;
 123   Handle(VrmlConverter_Projector) myPerespectiveCamera;
 124   Handle(VrmlConverter_Projector) myOrthographicCamera;
 125   Standard_Real myTransparency;
 126   Standard_Real myShininess;
 127   Handle(Vrml_Material) myFrontMaterial;
 128   Handle(Vrml_Material) myPointsMaterial;
 129   Handle(Vrml_Material) myUisoMaterial;
 130   Handle(Vrml_Material) myVisoMaterial;
 131   Handle(Vrml_Material) myLineMaterial;
 132   Handle(Vrml_Material) myWireMaterial;
 133   Handle(Vrml_Material) myFreeBoundsMaterial;
 134   Handle(Vrml_Material) myUnfreeBoundsMaterial;
 135   Standard_Real DX;
 136   Standard_Real DY;
 137   Standard_Real DZ;
 138   Standard_Real XUp;
 139   Standard_Real YUp;
 140   Standard_Real ZUp;
 141   Standard_Real Focus;
 142
 143 };
 144
 145 #endif // _VrmlAPI_Writer_HeaderFile