smesh/src/OBJECT/SMESH_Object.h

// Copyright (C) 2007-2015  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_Object.h
//  Author : Nicolas REJNERI
//  Module : SMESH
//
#ifndef SMESH_OBJECT_H
#define SMESH_OBJECT_H

#ifdef WIN32
 #if defined SMESHOBJECT_EXPORTS || defined SMESHObject_EXPORTS
  #define SMESHOBJECT_EXPORT __declspec( dllexport )
 #else
  #define SMESHOBJECT_EXPORT __declspec( dllimport )
 #endif
#else
 #define SMESHOBJECT_EXPORT
#endif

#include <boost/shared_ptr.hpp>
#include <vtkSystemIncludes.h>

#include "SMESH_Controls.hxx"
#include "SMDSAbs_ElementType.hxx"

#include <SALOMEconfig.h>
#include CORBA_SERVER_HEADER(SMESH_Mesh)

class SMDS_Mesh;
class vtkUnstructuredGrid;

/*
  Class       : SMESH_VisualObj
  Description : Base class for all mesh objects to be visuilised
*/
class SMESHOBJECT_EXPORT SMESH_VisualObj
{
public:
  virtual bool Update( int theIsClear = true ) = 0;
  virtual bool NulData() = 0;
  virtual void UpdateFunctor( const SMESH::Controls::FunctorPtr& theFunctor ) = 0;
  virtual int GetElemDimension( const int theObjId ) = 0;

  virtual int GetNbEntities( const SMDSAbs_ElementType theType) const = 0;
  virtual SMDS_Mesh* GetMesh() const = 0;
  virtual SMESH::SMESH_Mesh_ptr GetMeshServer() = 0;

  virtual bool GetEdgeNodes( const int theElemId,
                             const int theEdgeNum,
                             int&      theNodeId1,
                             int&      theNodeId2 ) const = 0;
  virtual bool              IsValid() const = 0;
  
  virtual vtkUnstructuredGrid* GetUnstructuredGrid() = 0;
  
  virtual vtkIdType GetNodeObjId( int theVTKID ) = 0;
  virtual vtkIdType GetNodeVTKId( int theObjID ) = 0;
  virtual vtkIdType GetElemObjId( int theVTKID ) = 0;
  virtual vtkIdType GetElemVTKId( int theObjID ) = 0;
  virtual void              ClearEntitiesFlags() = 0;
  virtual bool              GetEntitiesFlag() = 0;
  virtual unsigned int      GetEntitiesState() = 0;
};

typedef boost::shared_ptr<SMESH_VisualObj> TVisualObjPtr;

#endif