OCCT

// Created on: 2000-06-20
// Created by: Sergey MOZOKHIN
// Copyright (c) 2000-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _VrmlAPI_Writer_HeaderFile
#define _VrmlAPI_Writer_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <VrmlAPI_RepresentationOfShape.hxx>
#include <Quantity_Color.hxx>
#include <NCollection_Array1.hxx>
#include <NCollection_HArray1.hxx>
#include <Standard_Integer.hxx>
#include <Vrml_Material.hxx>

class VrmlConverter_Drawer;
class VrmlConverter_Projector;
class TopoDS_Shape;
class TDocStd_Document;

//! Creates and writes VRML files from Open
//! CASCADE shapes. A VRML file can be written to
//! an existing VRML file or to a new one.
class VrmlAPI_Writer
{
public:
  DEFINE_STANDARD_ALLOC

  //! Creates a writer object with default parameters.
  Standard_EXPORT VrmlAPI_Writer();

  //! Resets all parameters (representation, deflection)
  //! to their default values..
  Standard_EXPORT void ResetToDefaults();

  //! Returns drawer object
  Standard_EXPORT occ::handle<VrmlConverter_Drawer> Drawer() const;

  //! Sets the deflection aDef of
  //! the mesh algorithm which is used to compute the shaded
  //! representation of the translated shape. The default
  //! value is -1. When the deflection value is less than
  //! 0, the deflection is calculated from the relative
  //! size of the shaped.
  Standard_EXPORT void SetDeflection(const double aDef);

  //! Sets the representation of the
  //! shape aRep which is written to the VRML file. The three options are :
  //! -      shaded
  //! -      wireframe
  //! -      both shaded and wireframe (default)
  //! defined through the VrmlAPI_RepresentationOfShape enumeration.
  Standard_EXPORT void SetRepresentation(const VrmlAPI_RepresentationOfShape aRep);

  //! Returns the representation of the shape which is
  //! written to the VRML file. Types of representation are set through the
  //! VrmlAPI_RepresentationOfShape enumeration.
  Standard_EXPORT VrmlAPI_RepresentationOfShape GetRepresentation() const;

  //! @deprecated Call Vrml_Material::SetTransparency() directly instead.
  Standard_DEPRECATED("Call Vrml_Material::SetTransparency() directly instead")
  Standard_EXPORT void SetTransparencyToMaterial(occ::handle<Vrml_Material>& aMaterial,
                                                 const double                aTransparency);

  //! @deprecated Call Vrml_Material::SetShininess() directly instead.
  Standard_DEPRECATED("Call Vrml_Material::SetShininess() directly instead")
  Standard_EXPORT void SetShininessToMaterial(occ::handle<Vrml_Material>& aMaterial,
                                              const double                aShininess);

  //! @deprecated Call Vrml_Material::SetAmbientColor() directly instead.
  Standard_DEPRECATED("Call Vrml_Material::SetAmbientColor() directly instead")
  Standard_EXPORT void SetAmbientColorToMaterial(
    occ::handle<Vrml_Material>&                             aMaterial,
    const occ::handle<NCollection_HArray1<Quantity_Color>>& Color);

  //! @deprecated Call Vrml_Material::SetDiffuseColor() directly instead.
  Standard_DEPRECATED("Call Vrml_Material::SetDiffuseColor() directly instead")
  Standard_EXPORT void SetDiffuseColorToMaterial(
    occ::handle<Vrml_Material>&                             aMaterial,
    const occ::handle<NCollection_HArray1<Quantity_Color>>& Color);

  //! @deprecated Call Vrml_Material::SetSpecularColor() directly instead.
  Standard_DEPRECATED("Call Vrml_Material::SetSpecularColor() directly instead")
  Standard_EXPORT void SetSpecularColorToMaterial(
    occ::handle<Vrml_Material>&                             aMaterial,
    const occ::handle<NCollection_HArray1<Quantity_Color>>& Color);

  //! @deprecated Call Vrml_Material::SetEmissiveColor() directly instead.
  Standard_DEPRECATED("Call Vrml_Material::SetEmissiveColor() directly instead")
  Standard_EXPORT void SetEmissiveColorToMaterial(
    occ::handle<Vrml_Material>&                             aMaterial,
    const occ::handle<NCollection_HArray1<Quantity_Color>>& Color);

  Standard_EXPORT occ::handle<Vrml_Material> GetFrontMaterial() const;

  Standard_EXPORT occ::handle<Vrml_Material> GetPointsMaterial() const;

  Standard_EXPORT occ::handle<Vrml_Material> GetUisoMaterial() const;

  Standard_EXPORT occ::handle<Vrml_Material> GetVisoMaterial() const;

  Standard_EXPORT occ::handle<Vrml_Material> GetLineMaterial() const;

  Standard_EXPORT occ::handle<Vrml_Material> GetWireMaterial() const;

  Standard_EXPORT occ::handle<Vrml_Material> GetFreeBoundsMaterial() const;

  Standard_EXPORT occ::handle<Vrml_Material> GetUnfreeBoundsMaterial() const;

  //! Converts the shape aShape to
  //! VRML format of the passed version and writes it to the file identified by aFile.
  Standard_EXPORT bool Write(const TopoDS_Shape& aShape,
                             const char* const   aFile,
                             const int           aVersion = 2) const;

  //! Converts the document to VRML format of the passed version
  //! and writes it to the file identified by aFile.
  Standard_EXPORT bool WriteDoc(const occ::handle<TDocStd_Document>& theDoc,
                                const char* const                    theFile,
                                const double                         theScale) const;

  //! Converts the shape aShape to
  //! VRML format of the passed version and writes it to the given stream.
  Standard_EXPORT bool Write(const TopoDS_Shape& aShape,
                             Standard_OStream&   theOStream,
                             const int           aVersion = 2) const;

  //! Converts the document to VRML format of the passed version
  //! and writes it to the given stream.
  Standard_EXPORT bool WriteDoc(const occ::handle<TDocStd_Document>& theDoc,
                                Standard_OStream&                    theOStream,
                                const double                         theScale) const;

protected:
  //! Converts the shape aShape to VRML format of version 1.0 and writes it
  //! to the given stream using default parameters.
  Standard_EXPORT bool write_v1(const TopoDS_Shape& aShape, Standard_OStream& theOStream) const;

  //! Converts the shape aShape to VRML format of version 2.0 and writes it
  //! to the given stream using default parameters.
  Standard_EXPORT bool write_v2(const TopoDS_Shape& aShape, Standard_OStream& theOStream) const;

private:
  VrmlAPI_RepresentationOfShape        myRepresentation;
  occ::handle<VrmlConverter_Drawer>    myDrawer;
  double                               myDeflection;
  occ::handle<VrmlConverter_Projector> myPerespectiveCamera;
  occ::handle<VrmlConverter_Projector> myOrthographicCamera;
  double                               myTransparency;
  double                               myShininess;
  occ::handle<Vrml_Material>           myFrontMaterial;
  occ::handle<Vrml_Material>           myPointsMaterial;
  occ::handle<Vrml_Material>           myUisoMaterial;
  occ::handle<Vrml_Material>           myVisoMaterial;
  occ::handle<Vrml_Material>           myLineMaterial;
  occ::handle<Vrml_Material>           myWireMaterial;
  occ::handle<Vrml_Material>           myFreeBoundsMaterial;
  occ::handle<Vrml_Material>           myUnfreeBoundsMaterial;
  double                               DX;
  double                               DY;
  double                               DZ;
  double                               XUp;
  double                               YUp;
  double                               ZUp;
  double                               Focus;
};

#endif // _VrmlAPI_Writer_HeaderFile