vtkMRMLAbstractWidgetRepresentation.h

Go to the documentation of this file.

/*=========================================================================
 
 Copyright (c) ProxSim ltd., Kwun Tong, Hong Kong. All Rights Reserved.
 
 See COPYRIGHT.txt
 or http://www.slicer.org/copyright/copyright.txt for details.
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 
 This file was originally developed by Davide Punzo, punzodavide@hotmail.it,
 and development was supported by ProxSim ltd.
 
=========================================================================*/

 
#ifndef vtkMRMLAbstractWidgetRepresentation_h
#define vtkMRMLAbstractWidgetRepresentation_h
 
#include "vtkMRMLDisplayableManagerExport.h"
#include "vtkWidgetRepresentation.h"
 
#include "vtkMRMLAbstractViewNode.h"
#include "vtkMRMLApplicationLogic.h"
 
#include <vector>
 
class vtkMapper;
 
#include "vtkBoundingBox.h"
 
class VTK_MRML_DISPLAYABLEMANAGER_EXPORT vtkMRMLAbstractWidgetRepresentation : public vtkProp
{
public:
  vtkTypeMacro(vtkMRMLAbstractWidgetRepresentation, vtkProp);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  double* GetBounds() VTK_SIZEHINT(6) override { return nullptr; }
  void GetActors(vtkPropCollection*) override {}
  void GetActors2D(vtkPropCollection*) override {}
  void GetVolumes(vtkPropCollection*) override {}
  void ReleaseGraphicsResources(vtkWindow*) override {}
  int RenderOverlay(vtkViewport* vtkNotUsed(viewport)) override { return 0; }
  int RenderOpaqueGeometry(vtkViewport* vtkNotUsed(viewport)) override { return 0; }
  int RenderTranslucentPolygonalGeometry(vtkViewport* vtkNotUsed(viewport)) override { return 0; }
  int RenderVolumetricGeometry(vtkViewport* vtkNotUsed(viewport)) override { return 0; }
  vtkTypeBool HasTranslucentPolygonalGeometry() override { return 0; }


  virtual void SetRenderer(vtkRenderer* ren);
  virtual vtkRenderer* GetRenderer();


  virtual void SetApplicationLogic(vtkMRMLApplicationLogic* appLogic);
  virtual vtkMRMLApplicationLogic* GetApplicationLogic();


  virtual void SetViewNode(vtkMRMLAbstractViewNode* viewNode);
  virtual vtkMRMLAbstractViewNode* GetViewNode();

  virtual void UpdateFromMRML(vtkMRMLNode* caller, unsigned long event, void* callData = nullptr);

  vtkSetMacro(PickingTolerance, double);
  vtkGetMacro(PickingTolerance, double);


  vtkSetMacro(AlwaysOnTop, bool);
  vtkGetMacro(AlwaysOnTop, bool);
  vtkBooleanMacro(AlwaysOnTop, bool);


  vtkGetMacro(NeedToRender, bool);
  vtkSetMacro(NeedToRender, bool);
  vtkBooleanMacro(NeedToRender, bool);

  double GetScreenScaleFactor();


  vtkSetMacro(AlwaysOnTopRelativeOffsetFactor, double);
  vtkGetMacro(AlwaysOnTopRelativeOffsetFactor, double);
  vtkSetMacro(AlwaysOnTopRelativeOffsetUnits, double);
  vtkGetMacro(AlwaysOnTopRelativeOffsetUnits, double);
 
protected:
  vtkMRMLAbstractWidgetRepresentation();
  ~vtkMRMLAbstractWidgetRepresentation() override;

  void AddActorsBounds(vtkBoundingBox& bounds, const std::vector<vtkProp*>& actors, double* additionalBounds = nullptr);

  void GetRendererComputedDisplayPositionFromWorldPosition(const double worldPos[3], double displayPos[2]);
 
  virtual void UpdateRelativeCoincidentTopologyOffsets(vtkMapper* mapper);

  vtkWeakPointer<vtkRenderer> Renderer;
 
  vtkWeakPointer<vtkMRMLApplicationLogic> ApplicationLogic;
 
  bool NeedToRender;

  double PickingTolerance;
 
  vtkWeakPointer<vtkMRMLAbstractViewNode> ViewNode;
 
  bool AlwaysOnTop;

  double Bounds[6];

  double AlwaysOnTopRelativeOffsetFactor{ 0.0 };
  double AlwaysOnTopRelativeOffsetUnits{ -66000.0 };
 
private:
  vtkMRMLAbstractWidgetRepresentation(const vtkMRMLAbstractWidgetRepresentation&) = delete;
  void operator=(const vtkMRMLAbstractWidgetRepresentation&) = delete;
};
 
#endif