Salome HOME
GPUSPHGUI: show a custom control by setting a functor
[modules/smesh.git] / src / OBJECT / SMESH_Actor.h
index c58c309c5762a840eb38c8faf0e9309bc48871d3..7ad9d2f886909e799fde5ab6e3644be8aa24457a 100644 (file)
-//  File      : SMESH_Actor.h
-//  Created   : Mon May 13 22:30:51 2002
-//  Author    : Nicolas REJNERI
+// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
+//
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+//  SMESH OBJECT : interactive object for SMESH visualization
+//  File   : SMESH_Actor.h
+//  Author : Nicolas REJNERI
+//  Module : SMESH
+//
+#ifndef SMESH_ACTOR_H
+#define SMESH_ACTOR_H
 
-//  Project   : SALOME
-//  Module    : SMESH
-//  Copyright : Open CASCADE 2002
-//  $Header$
+#include <SALOMEconfig.h> // To fix some redefinition
+#include <SALOME_Actor.h>
+#include "SMESH_Object.h"
+#include "SMESH_ActorUtils.h"
 
+#include <vtkCommand.h>
 
-#ifndef SMESH_ACTOR_H
-#define SMESH_ACTOR_H
+class vtkUnstructuredGrid;
 
-#include "SALOME_Actor.h"
+class SMESH_ScalarBarActor;
 
-// VTK Includes
-#include <vtkActor.h>
-#include <vtkDataSetMapper.h>
-#include <vtkUnstructuredGridReader.h>
+class vtkPlane;
+class vtkImplicitBoolean;
 
-// Open CASCADE Includes
-#include <TColStd_IndexedMapOfInteger.hxx>
-#include <TColStd_DataMapOfIntegerInteger.hxx>
+#ifndef DISABLE_PLOT2DVIEWER
+class SPlot2d_Histogram;
+#endif
 
-typedef struct rgbStruct
+namespace SMESH
 {
-  float r;
-  float g;
-  float b;
-} RGBStruct;
+  const vtkIdType DeleteActorEvent = vtkCommand::UserEvent + 100;
+}
 
-class SMESH_Actor : public SALOME_Actor {
+class SMESHOBJECT_EXPORT SMESH_Actor: public SALOME_Actor
+{
+  static SMESH_Actor* New() { return NULL;}
 
  public:
   vtkTypeMacro(SMESH_Actor,SALOME_Actor);
+  static SMESH_Actor* New(TVisualObjPtr theVisualObj, 
+                          const char* theEntry, 
+                          const char* theName,
+                          int theIsClear);
+  
+  virtual void SetSufaceColor(double r,double g,double b, int delta ) = 0;
+  virtual void GetSufaceColor(double& r,double& g,double& b, int& delta ) = 0;
+    
+  virtual void SetVolumeColor(double r,double g,double b, int delta ) = 0;
+  virtual void GetVolumeColor(double& r,double& g,double& b, int& delta) = 0;
+
+  virtual void SetEdgeColor(double r,double g,double b) = 0;
+  virtual void GetEdgeColor(double& r,double& g,double& b) = 0;
+
+  virtual void SetNodeColor(double r,double g,double b) = 0;
+  virtual void GetNodeColor(double& r,double& g,double& b) = 0;
+  
+  virtual void SetOutlineColor(double r,double g,double b) = 0;
+  virtual void GetOutlineColor(double& r,double& g,double& b) = 0;  
+
+  virtual void Set0DColor(double r,double g,double b) = 0;
+  virtual void Get0DColor(double& r,double& g,double& b) = 0;
+
+  virtual void SetBallColor(double r,double g,double b) = 0;
+  virtual void GetBallColor(double& r,double& g,double& b) = 0;
+
+  virtual void SetHighlightColor(double r,double g,double b) = 0;
+  virtual void GetHighlightColor(double& r,double& g,double& b) = 0;
+
+  virtual void SetPreHighlightColor(double r,double g,double b) = 0;
+  virtual void GetPreHighlightColor(double& r,double& g,double& b) = 0;
+  virtual double GetLineWidth() = 0;
+  virtual void SetLineWidth(double theVal) = 0;
 
-  static SMESH_Actor* New();
-
-  // Description:
-  // This causes the actor to be rendered. It, in turn, will render the actor`s
-  // property and then mapper.
-  virtual void Render(vtkRenderer *, vtkMapper *);
-
-  // Description:
-  // This method is used internally by the rendering process.
-  // We overide the superclass method to properly set the estimated render time.
-  int RenderOpaqueGeometry(vtkViewport *viewport);
-
-  void ShallowCopy(vtkProp *prop);
-
-  void setReader(vtkUnstructuredGridReader* r) ;
-  vtkUnstructuredGridReader* getReader();
+  virtual double GetOutlineWidth() = 0;
+  virtual void SetOutlineWidth(double theVal) = 0;
 
-  // Highlight
-  virtual bool hasHighlight() { return true; }  
+  virtual void Set0DSize(double size) = 0;
+  virtual double Get0DSize() = 0;
 
-  vtkMapper* getMapper();
+  virtual void SetBallSize(double size) = 0;
+  virtual double GetBallSize() = 0;
 
-  void setDisplayMode(int);
+  virtual void SetBallScale(double size) = 0;
+  virtual double GetBallScale() = 0;
 
-  void SetColor(float r,float g,float b);
-  void GetColor(float& r,float& g,float& b);
-  void SetHighlightColor(float r,float g,float b);
-  void GetHighlightColor(float& r,float& g,float& b);
-  void SetPreselectedColor(float r,float g,float b);
-  void GetPreselectedColor(float& r,float& g,float& b);
+  enum EReperesent { ePoint, eEdge, eSurface};
+  
+  enum EEntityMode { e0DElements = 0x01, eEdges = 0x02, eFaces = 0x04, eVolumes = 0x08, eBallElem = 0x10, eAllEntity = 0x1f};
 
-  void SetEdgeColor(float r,float g,float b);
-  void GetEdgeColor(float& r,float& g,float& b);
-  void SetEdgeHighlightColor(float r,float g,float b);
-  void GetEdgeHighlightColor(float& r,float& g,float& b);
-  void SetEdgePreselectedColor(float r,float g,float b);
-  void GetEdgePreselectedColor(float& r,float& g,float& b);
+  enum EQuadratic2DRepresentation { eLines = 0x01, eArcs = 0x02 };
 
-  void SetNodeColor(float r,float g,float b);
-  void GetNodeColor(float& r,float& g,float& b);
-  void SetNodeSize(int size) ;
-  int  GetNodeSize() ;
+  virtual void SetEntityMode(unsigned int theMode) = 0;
+  virtual unsigned int GetEntityMode() const = 0;
 
+  virtual void SetQuadratic2DRepresentation(EQuadratic2DRepresentation) = 0;
+  virtual EQuadratic2DRepresentation GetQuadratic2DRepresentation() = 0;
 
-  void ClearNode();
-  void ClearElement();
+  virtual void SetPointRepresentation(bool theIsPointsVisible) = 0;
+  virtual bool GetPointRepresentation() = 0;
 
-  void RemoveNode(int idSMESHDSnode);
-  void RemoveElement(int idSMESHDSelement);
+  virtual vtkUnstructuredGrid* GetUnstructuredGrid() = 0;
 
-  void AddNode(int idSMESHDSnode, int idVTKnode);
-  void AddElement(int idSMESHDSelement, int idVTKelement);
+  virtual void SetShrinkFactor(double theValue) = 0;
 
-  int GetIdVTKNode(int idSMESHDSnode);
-  int GetIdVTKElement(int idSMESHDSelement);
+  virtual void SetPointsLabeled(bool theIsPointsLabeled) = 0;
+  virtual bool GetPointsLabeled() = 0;
 
-  int GetIdSMESHDSNode(int idVTKnode);
-  int GetIdSMESHDSElement(int idVTKelement);
+  virtual void SetCellsLabeled(bool theIsCellsLabeled) = 0;
+  virtual bool GetCellsLabeled() = 0;
 
-  void SetIdsVTKNode(const TColStd_DataMapOfIntegerInteger& mapVTK);
-  void SetIdsSMESHDSNode(const TColStd_DataMapOfIntegerInteger& mapSMESHDS);
+  virtual void SetFacesOriented(bool theIsFacesOriented) = 0;
+  virtual bool GetFacesOriented() = 0;
 
-  void SetIdsVTKElement(const TColStd_DataMapOfIntegerInteger& mapVTK);
-  void SetIdsSMESHDSElement(const TColStd_DataMapOfIntegerInteger& mapSMESHDS);
+  virtual void SetFacesOrientationColor(double r,double g,double b) = 0;
+  virtual void GetFacesOrientationColor(double& r,double& g,double& b) = 0;
 
-  vtkDataSet* DataSource;
-  vtkActor*   EdgeDevice;
-  vtkActor*   EdgeShrinkDevice;
+  virtual void SetFacesOrientationScale(double theScale) = 0;
+  virtual double GetFacesOrientationScale() = 0;
 
-  float GetShrinkFactor();
-  void  SetShrinkFactor(float value );
+  virtual void SetFacesOrientation3DVectors(bool theState) = 0;
+  virtual bool GetFacesOrientation3DVectors() = 0;
 
-  void GetChildActors(vtkActorCollection*);
+  enum eControl{eNone, eLength, eLength2D, eDeflection2D, eFreeBorders, eFreeEdges, eFreeNodes,
+                eFreeFaces, eMultiConnection, eArea, eTaper, eAspectRatio,
+                eMinimumAngle, eWarping, eSkew, eAspectRatio3D, eMultiConnection2D, eVolume3D,
+                eMaxElementLength2D, eMaxElementLength3D, eBareBorderFace, eBareBorderVolume,
+                eOverConstrainedFace, eOverConstrainedVolume, eCoincidentNodes,
+                eCoincidentElems1D, eCoincidentElems2D, eCoincidentElems3D, eNodeConnectivityNb,
+                eCustomControl };
+  virtual void SetControlMode(eControl theMode) = 0;
+  virtual void SetControl(SMESH::Controls::FunctorPtr) = 0;
+  virtual eControl GetControlMode() = 0;
+  virtual SMESH::Controls::FunctorPtr GetFunctor() = 0;
+  virtual int GetNumberControlEntities() = 0;
 
-  void SetVisibility(bool visibility);
+  virtual SMESH_ScalarBarActor* GetScalarBarActor() = 0;
 
- protected:
+  virtual void RemoveAllClippingPlanes() = 0; 
+  virtual vtkIdType GetNumberOfClippingPlanes() = 0; 
+  virtual vtkPlane* GetClippingPlane(vtkIdType theID) = 0; 
+  virtual vtkIdType AddClippingPlane(vtkPlane* thePlane) = 0; 
+  virtual void AddOpenGLClippingPlane(vtkPlane* thePlane) = 0;
+  virtual void SetOpenGLClippingPlane() = 0;
 
-  SMESH_Actor();
-  ~SMESH_Actor();
-  SMESH_Actor(const SMESH_Actor&) {};
-  void operator=(const SMESH_Actor&) {};
+  virtual TVisualObjPtr GetObject() = 0;
 
-  vtkUnstructuredGridReader* myReader;
+  virtual void SetControlsPrecision( const long ) = 0;
+  virtual long GetControlsPrecision() const = 0;
 
-  float myShrinkFactor;
+  virtual void UpdateScalarBar() = 0;
+  virtual void UpdateDistribution() = 0;
 
-  RGBStruct edgeColor;
-  RGBStruct edgeHighlightColor;
-  RGBStruct edgePreselectedColor;
+  virtual void SetPointsFontProperties( SMESH::LabelFont family, int size, 
+                                        bool bold, bool italic, bool shadow,
+                                        double r, double g, double b ) = 0;
+  virtual void SetCellsFontProperties( SMESH::LabelFont family, int size, 
+                                       bool bold, bool italic, bool shadow,
+                                       double r, double g, double b ) = 0;
 
-  RGBStruct actorColor;
-  RGBStruct actorHighlightColor;
-  RGBStruct actorPreselectedColor;
+#ifndef DISABLE_PLOT2DVIEWER
+  virtual SPlot2d_Histogram* GetPlot2Histogram() = 0;
+  virtual SPlot2d_Histogram* UpdatePlot2Histogram() = 0;
+#endif
+};
 
-  RGBStruct actorNodeColor; // LPN
-  int       actorNodeSize;  // LPN
 
-};
 #endif //SMESH_ACTOR_H