Slicer  5.0
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkSlicerROIRepresentation2D Class Reference

Default representation for the plane widget. More...

#include <Modules/Loadable/Markups/VTKWidgets/vtkSlicerROIRepresentation2D.h>

Inheritance diagram for vtkSlicerROIRepresentation2D:
Inheritance graph
[legend]
Collaboration diagram for vtkSlicerROIRepresentation2D:
Collaboration graph
[legend]

Classes

class  MarkupsInteractionPipelineROI2D
 

Public Types

typedef vtkSlicerMarkupsWidgetRepresentation2D Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkSlicerMarkupsWidgetRepresentation2D
typedef vtkSlicerMarkupsWidgetRepresentation Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkSlicerMarkupsWidgetRepresentation
enum  {
  Unselected, Selected, Active, Project,
  ProjectBack, NumberOfControlPointTypes
}
 
typedef vtkMRMLAbstractWidgetRepresentation Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkMRMLAbstractWidgetRepresentation
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 

Public Member Functions

void CanInteract (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2) override
 Position is displayed (slice) position. More...
 
void CanInteractWithROI (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2)
 
void GetActors (vtkPropCollection *) override
 Methods to make this class behave as a vtkProp. More...
 
double * GetBounds () override
 Return the bounds of the representation. More...
 
virtual const char * GetClassName ()
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 
int RenderOverlay (vtkViewport *viewport) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 
void UpdateFromMRML (vtkMRMLNode *caller, unsigned long event, void *callData=nullptr) override
 
void UpdateInteractionPipeline () override
 Update the interaction pipeline. More...
 
- Public Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation2D
virtual void CanInteractWithHandles (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2)
 Check if interaction with the transformation handles is possible. More...
 
void CanInteractWithLine (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2)
 
void GetActors (vtkPropCollection *) override
 Methods to make this class behave as a vtkProp. More...
 
int GetNthControlPointDisplayPosition (int n, double pos[2]) override
 
virtual bool GetNthControlPointViewVisibility (int n)
 
void GetSliceToWorldCoordinates (const double[2], double[3])
 
void GetWorldToSliceCoordinates (const double worldPos[3], double slicePos[2])
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 
int RenderOverlay (vtkViewport *viewport) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 
virtual void SetCenterSliceVisibility (bool visibility)
 Set the center slice visibility (i.e. if it is on the slice). More...
 
virtual void SetNthControlPointSliceVisibility (int n, bool visibility)
 Set the Nth node slice visibility (i.e. if it is on the slice). More...
 
- Public Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation
virtual int FindClosestPointOnWidget (const int displayPos[2], double worldPos[3], int *idx)
 
void GetActors (vtkPropCollection *) override
 Methods to make this class behave as a vtkProp. More...
 
virtual vtkPolyData * GetControlPointsPolyData (int controlPointType)
 
virtual void GetInteractionHandleAxisWorld (int type, int index, double axis[3])
 Get the axis for the handle specified by the index. More...
 
virtual void GetInteractionHandleOriginWorld (double origin[3])
 Get the origin of the interaction handle widget. More...
 
virtual void GetInteractionHandlePositionWorld (int type, int index, double position[3])
 Get the position of an interaction handle in world coordinates. More...
 
virtual vtkPolyData * GetLabelControlPointsPolyData (int pipeline)
 
virtual vtkStringArray * GetLabels (int pipeline)
 
virtual vtkMRMLMarkupsDisplayNodeGetMarkupsDisplayNode ()
 
virtual vtkMRMLMarkupsNodeGetMarkupsNode ()
 
virtual vtkMRMLMarkupsNode::ControlPointGetNthControlPoint (int n)
 Get the nth control point. More...
 
virtual int GetNumberOfControlPoints ()
 Get number of control points. More...
 
virtual vtkPointPlacer * GetPointPlacer ()
 
virtual bool GetTransformationReferencePoint (double referencePointWorld[3])
 Translation, rotation, scaling will happen around this position. More...
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 
int RenderOpaqueGeometry (vtkViewport *viewport) override
 
int RenderOverlay (vtkViewport *viewport) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
 
virtual void SetMarkupsDisplayNode (vtkMRMLMarkupsDisplayNode *markupsDisplayNode)
 Set/Get the vtkMRMLMarkipsNode connected with this representation. More...
 
virtual void UpdateCenterOfRotation ()
 Compute the center of rotation and update it in the Markups node. More...
 
bool IsDisplayable ()
 
- Public Member Functions inherited from vtkMRMLAbstractWidgetRepresentation
virtual void AlwaysOnTopOff ()
 
virtual void AlwaysOnTopOn ()
 
virtual bool GetAlwaysOnTop ()
 
virtual double GetPickingTolerance ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetAlwaysOnTop (bool)
 
virtual void SetPickingTolerance (double)
 
double * GetBounds () VTK_SIZEHINT(6) override
 
void GetActors (vtkPropCollection *) override
 
void GetActors2D (vtkPropCollection *) override
 
void GetVolumes (vtkPropCollection *) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 
int RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 
virtual void SetRenderer (vtkRenderer *ren)
 
virtual vtkRenderer * GetRenderer ()
 
virtual void SetViewNode (vtkMRMLAbstractViewNode *viewNode)
 
virtual vtkMRMLAbstractViewNodeGetViewNode ()
 
virtual bool GetNeedToRender ()
 
virtual void SetNeedToRender (bool)
 
virtual void NeedToRenderOn ()
 
virtual void NeedToRenderOff ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkSlicerROIRepresentation2DNew ()
 Instantiate this class. More...
 
static vtkSlicerROIRepresentation2DSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation2D
static int IsTypeOf (const char *type)
 
static vtkSlicerMarkupsWidgetRepresentation2DSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation
static int IsTypeOf (const char *type)
 
static vtkSlicerMarkupsWidgetRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractWidgetRepresentation
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractWidgetRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

void SetROISource (vtkPolyDataAlgorithm *roiSource)
 
void SetupInteractionPipeline () override
 Reimplemented for 2D specific mapper/actor settings. More...
 
virtual void UpdateCubeSourceFromMRML (vtkMRMLMarkupsROINode *roiNode)
 Update the cube source filter from the ROI node. More...
 
 vtkSlicerROIRepresentation2D ()
 
 ~vtkSlicerROIRepresentation2D () override
 
- Protected Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation2D
bool GetAllControlPointsVisible () override
 Convenience method. More...
 
ControlPointsPipeline2DGetControlPointsPipeline (int controlPointType)
 
double GetMaximumControlPointPickingDistance2 ()
 
double GetMaximumInteractionHandlePickingDistance2 ()
 
vtkMRMLSliceNodeGetSliceNode ()
 Get MRML view node as slice view node. More...
 
double GetWidgetOpacity (int controlPointType)
 
void GetWorldToDisplayCoordinates (double r, double a, double s, double *displayCoordinates)
 Convert display to world coordinates. More...
 
void GetWorldToDisplayCoordinates (double *worldCoordinates, double *displayCoordinates)
 
virtual bool IsCenterDisplayableOnSlice (vtkMRMLMarkupsNode *node)
 Check, if the point is displayable in the current slice geometry. More...
 
virtual bool IsControlPointDisplayableOnSlice (vtkMRMLMarkupsNode *node, int pointIndex=0)
 Check, if the point is displayable in the current slice geometry. More...
 
virtual bool IsPointBehindSlice (vtkMRMLMarkupsNode *node, int pointIndex=0)
 Check, if the point is behind in the current slice geometry. More...
 
virtual bool IsPointInFrontSlice (vtkMRMLMarkupsNode *node, int pointIndex=0)
 Check, if the point is in front in the current slice geometry. More...
 
bool IsRepresentationIntersectingSlice (vtkPolyData *representation, const char *arrayName)
 Check if the representation polydata intersects the slice. More...
 
virtual void UpdateAllPointsAndLabelsFromMRML (double labelsOffset)
 
void UpdateControlPointSize () override
 
virtual void UpdateDistanceColorMap (vtkDiscretizableColorTransferFunction *colormap, double color[3])
 
void UpdatePlaneFromSliceNode ()
 
void UpdateViewScaleFactor () override
 
 vtkSlicerMarkupsWidgetRepresentation2D ()
 
 ~vtkSlicerMarkupsWidgetRepresentation2D () override
 
- Protected Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation
void BuildLine (vtkPolyData *linePolyData, bool displayPosition)
 
bool GetAllControlPointsSelected ()
 Convenience method. More...
 
double * GetWidgetColor (int controlPointType)
 
virtual void SetMarkupsNode (vtkMRMLMarkupsNode *markupsNode)
 
virtual void UpdateInteractionHandleSize ()
 
 vtkSlicerMarkupsWidgetRepresentation ()
 
 ~vtkSlicerMarkupsWidgetRepresentation () override
 
- Protected Member Functions inherited from vtkMRMLAbstractWidgetRepresentation
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)
 
 vtkMRMLAbstractWidgetRepresentation ()
 
 ~vtkMRMLAbstractWidgetRepresentation () override
 

Protected Attributes

vtkSmartPointer< vtkActor2D > ROIActor
 
vtkSmartPointer< vtkContourTriangulator > ROIIntersectionTriangulator
 
vtkSmartPointer< vtkPolyDataMapper2D > ROIMapper
 
vtkSmartPointer< vtkActor2D > ROIOutlineActor
 
vtkSmartPointer< vtkCutter > ROIOutlineCutter
 
vtkSmartPointer< vtkPolyDataMapper2D > ROIOutlineMapper
 
vtkSmartPointer< vtkProperty2D > ROIOutlineProperty
 
vtkSmartPointer< vtkTransformPolyDataFilter > ROIOutlineWorldToSliceTransformFilter
 
vtkSmartPointer< vtkPassThroughFilter > ROIPipelineInputFilter
 
vtkSmartPointer< vtkProperty2D > ROIProperty
 
vtkSmartPointer< vtkPolyDataAlgorithm > ROISource
 
vtkSmartPointer< vtkTransform > ROIToWorldTransform
 
vtkSmartPointer< vtkTransformPolyDataFilter > ROIToWorldTransformFilter
 
- Protected Attributes inherited from vtkSlicerMarkupsWidgetRepresentation2D
bool AnyPointVisibilityOnSlice = { false }
 
bool CenterVisibilityOnSlice = { false }
 
vtkSmartPointer< vtkIntArray > PointsVisibilityOnSlice
 
vtkSmartPointer< vtkPlane > SlicePlane
 
vtkSmartPointer< vtkTransform > WorldToSliceTransform
 
- Protected Attributes inherited from vtkSlicerMarkupsWidgetRepresentation
ControlPointsPipelineControlPoints [NumberOfControlPointTypes]
 
double ControlPointSize
 
vtkTypeBool CurveClosed
 
MarkupsInteractionPipelineInteractionPipeline
 
vtkWeakPointer< vtkMRMLMarkupsDisplayNodeMarkupsDisplayNode
 
vtkWeakPointer< vtkMRMLMarkupsNodeMarkupsNode
 
vtkTimeStamp MarkupsTransformModifiedTime
 
vtkSmartPointer< vtkPointPlacer > PointPlacer
 
double ScreenSizePixel
 
vtkSmartPointer< vtkTextActor > TextActor
 
double ViewScaleFactorMmPerPixel
 
- Protected Attributes inherited from vtkMRMLAbstractWidgetRepresentation
bool AlwaysOnTop
 
double Bounds [6]
 Temporary variable to store GetBounds() result. More...
 
bool NeedToRender
 
double PickingTolerance
 
vtkWeakPointer< vtkRenderer > Renderer
 The renderer in which this widget is placed. More...
 
double ScreenScaleFactor
 Allows global rescaling of all widgets (to compensate for larger or smaller physical screen size) More...
 
vtkWeakPointer< vtkMRMLAbstractViewNodeViewNode
 

Additional Inherited Members

- Protected Types inherited from vtkSlicerMarkupsWidgetRepresentation
typedef std::vector< MarkupsInteractionPipeline::HandleInfoHandleInfoList
 
- Static Protected Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation
static int GetGlyphTypeSourceFromDisplay (int glyphTypeDisplay)
 

Detailed Description

Default representation for the plane widget.

This class provides the default concrete representation for the vtkMRMLAbstractWidget. See vtkMRMLAbstractWidget for details.

See also
vtkSlicerMarkupsWidgetRepresentation2D vtkMRMLAbstractWidget

Definition at line 48 of file vtkSlicerROIRepresentation2D.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 55 of file vtkSlicerROIRepresentation2D.h.

Constructor & Destructor Documentation

◆ vtkSlicerROIRepresentation2D()

vtkSlicerROIRepresentation2D::vtkSlicerROIRepresentation2D ( )
protected

◆ ~vtkSlicerROIRepresentation2D()

vtkSlicerROIRepresentation2D::~vtkSlicerROIRepresentation2D ( )
overrideprotected

Member Function Documentation

◆ CanInteract()

void vtkSlicerROIRepresentation2D::CanInteract ( vtkMRMLInteractionEventData interactionEventData,
int &  foundComponentType,
int &  foundComponentIndex,
double &  closestDistance2 
)
overridevirtual

Position is displayed (slice) position.

Reimplemented from vtkSlicerMarkupsWidgetRepresentation2D.

◆ CanInteractWithROI()

void vtkSlicerROIRepresentation2D::CanInteractWithROI ( vtkMRMLInteractionEventData interactionEventData,
int &  foundComponentType,
int &  foundComponentIndex,
double &  closestDistance2 
)

◆ GetActors()

void vtkSlicerROIRepresentation2D::GetActors ( vtkPropCollection *  )
override

Methods to make this class behave as a vtkProp.

◆ GetBounds()

double* vtkSlicerROIRepresentation2D::GetBounds ( )
override

Return the bounds of the representation.

◆ GetClassName()

virtual const char* vtkSlicerROIRepresentation2D::GetClassName ( )
virtual

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkSlicerROIRepresentation2D::HasTranslucentPolygonalGeometry ( )
override

◆ IsA()

virtual int vtkSlicerROIRepresentation2D::IsA ( const char *  type)
virtual

◆ IsTypeOf()

static int vtkSlicerROIRepresentation2D::IsTypeOf ( const char *  type)
static

◆ New()

static vtkSlicerROIRepresentation2D* vtkSlicerROIRepresentation2D::New ( )
static

Instantiate this class.

◆ PrintSelf()

void vtkSlicerROIRepresentation2D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ReleaseGraphicsResources()

void vtkSlicerROIRepresentation2D::ReleaseGraphicsResources ( vtkWindow *  )
override

◆ RenderOpaqueGeometry()

int vtkSlicerROIRepresentation2D::RenderOpaqueGeometry ( vtkViewport *  viewport)
override

◆ RenderOverlay()

int vtkSlicerROIRepresentation2D::RenderOverlay ( vtkViewport *  viewport)
override

◆ RenderTranslucentPolygonalGeometry()

int vtkSlicerROIRepresentation2D::RenderTranslucentPolygonalGeometry ( vtkViewport *  viewport)
override

◆ SafeDownCast()

static vtkSlicerROIRepresentation2D* vtkSlicerROIRepresentation2D::SafeDownCast ( vtkObject *  o)
static

◆ SetROISource()

void vtkSlicerROIRepresentation2D::SetROISource ( vtkPolyDataAlgorithm *  roiSource)
protected

◆ SetupInteractionPipeline()

void vtkSlicerROIRepresentation2D::SetupInteractionPipeline ( )
overrideprotectedvirtual

Reimplemented for 2D specific mapper/actor settings.

Reimplemented from vtkSlicerMarkupsWidgetRepresentation2D.

◆ UpdateCubeSourceFromMRML()

virtual void vtkSlicerROIRepresentation2D::UpdateCubeSourceFromMRML ( vtkMRMLMarkupsROINode roiNode)
protectedvirtual

Update the cube source filter from the ROI node.

◆ UpdateFromMRML()

void vtkSlicerROIRepresentation2D::UpdateFromMRML ( vtkMRMLNode caller,
unsigned long  event,
void *  callData = nullptr 
)
overridevirtual

Subclasses of vtkContourCurveRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkSlicerMarkupsWidgetRepresentation2D.

◆ UpdateInteractionPipeline()

void vtkSlicerROIRepresentation2D::UpdateInteractionPipeline ( )
overridevirtual

Update the interaction pipeline.

Reimplemented from vtkSlicerMarkupsWidgetRepresentation2D.

Member Data Documentation

◆ ROIActor

vtkSmartPointer<vtkActor2D> vtkSlicerROIRepresentation2D::ROIActor
protected

Definition at line 108 of file vtkSlicerROIRepresentation2D.h.

◆ ROIIntersectionTriangulator

vtkSmartPointer<vtkContourTriangulator> vtkSlicerROIRepresentation2D::ROIIntersectionTriangulator
protected

Definition at line 104 of file vtkSlicerROIRepresentation2D.h.

◆ ROIMapper

vtkSmartPointer<vtkPolyDataMapper2D> vtkSlicerROIRepresentation2D::ROIMapper
protected

Definition at line 106 of file vtkSlicerROIRepresentation2D.h.

◆ ROIOutlineActor

vtkSmartPointer<vtkActor2D> vtkSlicerROIRepresentation2D::ROIOutlineActor
protected

Definition at line 112 of file vtkSlicerROIRepresentation2D.h.

◆ ROIOutlineCutter

vtkSmartPointer<vtkCutter> vtkSlicerROIRepresentation2D::ROIOutlineCutter
protected

Definition at line 102 of file vtkSlicerROIRepresentation2D.h.

◆ ROIOutlineMapper

vtkSmartPointer<vtkPolyDataMapper2D> vtkSlicerROIRepresentation2D::ROIOutlineMapper
protected

Definition at line 110 of file vtkSlicerROIRepresentation2D.h.

◆ ROIOutlineProperty

vtkSmartPointer<vtkProperty2D> vtkSlicerROIRepresentation2D::ROIOutlineProperty
protected

Definition at line 111 of file vtkSlicerROIRepresentation2D.h.

◆ ROIOutlineWorldToSliceTransformFilter

vtkSmartPointer<vtkTransformPolyDataFilter> vtkSlicerROIRepresentation2D::ROIOutlineWorldToSliceTransformFilter
protected

Definition at line 103 of file vtkSlicerROIRepresentation2D.h.

◆ ROIPipelineInputFilter

vtkSmartPointer<vtkPassThroughFilter> vtkSlicerROIRepresentation2D::ROIPipelineInputFilter
protected

Definition at line 99 of file vtkSlicerROIRepresentation2D.h.

◆ ROIProperty

vtkSmartPointer<vtkProperty2D> vtkSlicerROIRepresentation2D::ROIProperty
protected

Definition at line 107 of file vtkSlicerROIRepresentation2D.h.

◆ ROISource

vtkSmartPointer<vtkPolyDataAlgorithm> vtkSlicerROIRepresentation2D::ROISource
protected

Definition at line 97 of file vtkSlicerROIRepresentation2D.h.

◆ ROIToWorldTransform

vtkSmartPointer<vtkTransform> vtkSlicerROIRepresentation2D::ROIToWorldTransform
protected

Definition at line 100 of file vtkSlicerROIRepresentation2D.h.

◆ ROIToWorldTransformFilter

vtkSmartPointer<vtkTransformPolyDataFilter> vtkSlicerROIRepresentation2D::ROIToWorldTransformFilter
protected

Definition at line 101 of file vtkSlicerROIRepresentation2D.h.


The documentation for this class was generated from the following file: