0024904: Visualization - Integration of VIS component:
[occt.git] / src / IVtkTools / IVtkTools.hxx
diff --git a/src/IVtkTools/IVtkTools.hxx b/src/IVtkTools/IVtkTools.hxx
new file mode 100644 (file)
index 0000000..3a580cf
--- /dev/null
@@ -0,0 +1,88 @@
+// Created on: 2011-10-14 
+// Created by: Roman KOZLOV
+// Copyright (c) 2011-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 IVtkTOOLS_H
+#define IVtkTOOLS_H
+
+#include <IVtk_Types.hxx>
+
+#if defined(_WIN32) && !defined(HAVE_NO_DLL)
+  #ifdef __IVtkTools_DLL
+    #define IVtkTools_EXPORT __declspec( dllexport )
+  #else
+    #define IVtkTools_EXPORT __declspec( dllimport )
+  #endif
+#else
+  #define IVtkTools_EXPORT
+#endif
+
+class vtkLookupTable;
+class vtkMapper;
+
+//! Helper methods to facilitate usage of VIS classes in an application.
+namespace IVtkTools
+{
+
+  //! Returns vtkLookupTable instance initialized by standrad OCCT colors used 
+  //! in wireframe mode for different kinds of sub-shapes (free/boundary/shared 
+  //! edges, isolines,...)
+  Standard_EXPORT vtkLookupTable* InitLookupTable();
+
+  //! Set a color for given type of sub-shapes.
+  //! @param [in,out] theColorTable vtkLookupTable to set the color.
+  //! @param [in]  theColorRole type of sub-shapes to set the color.
+  //! @param [in]  theR red color component. Use [0,1] double values.
+  //! @param [in]  theG green color component. Use [0,1] double values.
+  //! @param [in]  theB blue color component. Use [0,1] double values.
+  //! @param [in]  theA the alpha value (the opacity) as a double between 0 and 1.
+  Standard_EXPORT void SetLookupTableColor (vtkLookupTable* theColorTable, 
+                                            const IVtk_MeshType theColorRole, 
+                                            const double theR, const double theG, const double theB, 
+                                            const double theA = 1);
+
+  //! Get a color for given type of sub-shapes.
+  //! @param [in]  theColorTable vtkLookupTable to set the color.
+  //! @param [in]  theColorRole type of sub-shapes to set the color.
+  //! @param [out] theR red color component as a double between 0 and 1.
+  //! @param [out] theG green color component as a double between 0 and 1.
+  //! @param [out] theB blue color component as a double between 0 and 1.
+  Standard_EXPORT void GetLookupTableColor (vtkLookupTable* theColorTable, 
+                                            const IVtk_MeshType theColorRole, 
+                                            double &theR, double &theG, double &theB);
+
+  //! Get a color for given type of sub-shapes.
+  //! @param [in]  theColorTable vtkLookupTable to set the color.
+  //! @param [in]  theColorRole type of sub-shapes to set the color.
+  //! @param [out] theR red color component as a double between 0 and 1.
+  //! @param [out] theG green color component as a double between 0 and 1.
+  //! @param [out] theB blue color component as a double between 0 and 1.
+  //! @param [out] theA the alpha value (the opacity) as a double between 0 and 1.
+  Standard_EXPORT void GetLookupTableColor (vtkLookupTable* theColorTable, 
+                                            const IVtk_MeshType theColorRole, 
+                                            double &theR, double &theG, double &theB, 
+                                            double &theA);
+
+  //! Set up the initial shape mapper parameters with default OCC colors.
+  Standard_EXPORT void InitShapeMapper (vtkMapper* theMapper);
+
+  //! Set up the initial shape mapper parameters with user colors.
+  //! @param [in,out] theMapper mapper to initialize
+  //! @param [in] theColorTable a table with user's colors definition
+  Standard_EXPORT void InitShapeMapper (vtkMapper* theMapper, 
+                                        vtkLookupTable* theColorTable);
+
+};
+
+#endif // IVtkTOOLS_H