src/VISU_I/VISU_Prs3d_i.hh

Go to the documentation of this file.

// Copyright (C) 2007-2011  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.
//
// 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
//

//  VISU OBJECT : interactive object for VISU entities implementation
//  File   : VISU_PrsObject_i.hxx
//  Author : Alexey PETROV
//  Module : VISU
//
#ifndef VISU_Prs3d_i_HeaderFile
#define VISU_Prs3d_i_HeaderFile

#include "VISU_PrsObject_i.hh"

#include "VISU_ActorFactory.h"
#include "VISU_ConvertorDef.hxx"

#include "SALOME_GenericObj_i.hh"
#include "SALOME_GenericObjPointer.hh"
#include "SALOME_InteractiveObject.hxx"

#include "VTKViewer.h"

#include <vtkSmartPointer.h>
#include <vtkTimeStamp.h>

class VISU_PipeLine;
class VISU_ActorBase;
class VISU_Actor;

class vtkPlane;
class vtkActorCollection;
class vtkDataSet;

namespace VISU
{
  //----------------------------------------------------------------------------
  class Result_i;


  //----------------------------------------------------------------------------
  struct TResultObserver: public virtual boost::signalslib::trackable
  {
    virtual
    void
    UpdateFromResult(Result_i* theResult) = 0;
  };


  //----------------------------------------------------------------------------

  class VISU_I_EXPORT Prs3d_i : public virtual POA_VISU::Prs3d,
                    public virtual SALOME::GenericObj_i,
                    public virtual TActorFactory,
                    public virtual PrsObject_i

  {
    Prs3d_i(const Prs3d_i&);

  public:
    //----------------------------------------------------------------------------
    typedef PrsObject_i TSuperClass;
    typedef VISU::Prs3d TInterface;

    //----------------------------------------------------------------------------
    Prs3d_i();

    virtual
    void
    SameAs(const Prs3d_i* theOrigin);

    virtual
    ~Prs3d_i();

    //----------------------------------------------------------------------------
    virtual
    CORBA::Boolean 
    Apply(bool theReInit);

    //----------------------------------------------------------------------------
    void 
    SetCResult(Result_i* theResult);

    Result_i* 
    GetCResult() const;

    virtual
    void 
    SetResultObject(VISU::Result_ptr theResult);

    virtual
    VISU::Result_ptr
    GetResultObject();

    //----------------------------------------------------------------------------
    virtual
    void 
    SetMeshName(const char* theMeshName);

    virtual
    char*
    GetMeshName();

    std::string
    GetCMeshName() const;

    //----------------------------------------------------------------------------
    virtual
    const char* 
    GetComment() const = 0;

    virtual
    QString
    GenerateName() = 0;

    virtual
    void
    ToStream(std::ostringstream& theStr);

    virtual
    Storable* 
    Restore(SALOMEDS::SObject_ptr theSObject,
         const Storable::TRestoringMap& theMap);

    //----------------------------------------------------------------------------
    virtual
    SALOMEDS::SObject_var 
    GetSObject();

    //----------------------------------------------------------------------------
    virtual 
    void
    Update();

    virtual
    void
    RemoveFromStudy();

    //----------------------------------------------------------------------------
    VISU_PipeLine* 
    GetPipeLine() const;

    bool
    IsPipeLineExists();

    vtkDataSet* 
    GetInput();

    //----------------------------------------------------------------------------
    virtual 
    VISU_Actor* 
    CreateActor() = 0;

    virtual 
    void
    RemoveActor(VISU_ActorBase* theActor);

    virtual 
    void
    RemoveActors();

    virtual 
    void
    UpdateActor(VISU_ActorBase* theActor);

    virtual 
    void
    UpdateActors();

    //----------------------------------------------------------------------------
    // Clipping planes
    void
    RemoveAllClippingPlanes();

    bool
    AddClippingPlane(vtkPlane* thePlane);

    vtkIdType
    GetNumberOfClippingPlanes() const;

    vtkPlane* 
    GetClippingPlane(vtkIdType theID) const;

    void RemoveClippingPlane(vtkIdType theID);

    void
    SetPlaneParam(vtkFloatingPointType theDir[3], 
            vtkFloatingPointType theDist, 
            vtkPlane* thePlane);

    //----------------------------------------------------------------------------
    void
    GetBounds(vtkFloatingPointType aBounds[6]);

    int
    GetNumberOfActors();

    bool
    HasVisibleActors();

    void
    SetOffset(const CORBA::Float* theOffsets);

    virtual
    void
    SetOffset(CORBA::Float theDx, 
           CORBA::Float theDy, 
           CORBA::Float theDz);

    void
    GetOffset(CORBA::Float* theOffsets);

    virtual
    void
    GetOffset(CORBA::Float& theDx, 
           CORBA::Float& theDy, 
           CORBA::Float& theDz);

    //----------------------------------------------------------------------------
    virtual
    void
    SetMarkerStd(VISU::MarkerType theMarkerType, VISU::MarkerScale theMarkerScale);
  
    virtual
    void
    SetMarkerTexture(CORBA::Long theTextureId);
  
    virtual
    VISU::MarkerType
    GetMarkerType();

    virtual
    VISU::MarkerScale
    GetMarkerScale();

    virtual
    CORBA::Long
    GetMarkerTexture();
  
    //----------------------------------------------------------------------------
    virtual
    CORBA::Float
    GetMemorySize();

    //----------------------------------------------------------------------------
    virtual
    bool 
    GetActiveState();

    //----------------------------------------------------------------------------
    virtual
    unsigned long int 
    GetMTime();

    //----------------------------------------------------------------------------
    virtual
    Handle(SALOME_InteractiveObject)
    GetIO();

    virtual
    std::string
    GetActorEntry();

    //----------------------------------------------------------------------------
    bool
    IsForcedHidden() const;

    void
    SetForcedHidden( bool );

  protected:
    virtual 
    bool 
    SetInput(bool theReInit);

    virtual 
    void 
    OnRestoreInput();

    void
    SetPipeLine(VISU_PipeLine* thePipeLine);

    void
    CreateActor(VISU_Actor* theActor);

    virtual 
    VISU_PipeLine* 
    GetActorPipeLine();

    virtual
    void
    CheckDataSet();

    bool
    LoadMarkerTexture(int theMarkerId, VTK::MarkerTexture& theMarkerTexture);

  protected:
    vtkTimeStamp myUpdateTime;
    vtkTimeStamp myParamsTime;

  private:
    void
    SetResultEntry(const std::string& theResultEntry);

    std::string
    GetResultEntry();

    typedef SALOME::GenericObjPtr<VISU::Result_i> TResultPtr;
    TResultPtr myResult;
    TResultPtr myPreviousResult;

    std::string myMeshName;
    std::string myPreviousMeshName;

    CORBA::Float myOffset[3];

    VISU::MarkerType myMarkerType;
    VISU::MarkerScale myMarkerScale;
    int myMarkerId;

    boost::signal0<void> myUpdateActorsSignal;
    boost::signal0<void> myRemoveActorsFromRendererSignal;
    vtkSmartPointer<vtkActorCollection> myActorCollection;

    vtkSmartPointer<VISU_PipeLine> myPipeLine;

    Handle(SALOME_InteractiveObject) myIO;

  private:
    friend class ColoredPrs3dCache_i;

    void
    SetActiveState(bool theState);
    
    bool myIsActiveSatate;

    bool myIsForcedHidden;
  };

  //----------------------------------------------------------------------------
}

#endif