Slicer  4.11
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
vtkSlicerMarkupsWidgetRepresentation2D Class Reference

Default representation for the slicer markups widget. More...

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

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

Classes

class  ControlPointsPipeline2D
 

Public Types

typedef vtkSlicerMarkupsWidgetRepresentation Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkSlicerMarkupsWidgetRepresentation
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 CanInteractWithLine (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2)
 
void GetActors (vtkPropCollection *) override
 Methods to make this class behave as a vtkProp. More...
 
virtual const char * GetClassName ()
 
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
 
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
 
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...
 
void UpdateFromMRML (vtkMRMLNode *caller, unsigned long event, void *callData=nullptr) override
 
- Public Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation
virtual int FindClosestPointOnWidget (const int displayPos[2], double worldPos[3], int *idx)
 
virtual vtkMRMLMarkupsDisplayNodeGetMarkupsDisplayNode ()
 
virtual vtkMRMLMarkupsNodeGetMarkupsNode ()
 
virtual vtkMRMLMarkupsNode::ControlPointGetNthControlPoint (int n)
 Get the nth node. More...
 
vtkPointPlacer * GetPointPlacer ()
 
virtual bool GetTransformationReferencePoint (double referencePointWorld[3])
 Translation, rotation, scaling will happen around this position. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetMarkupsDisplayNode (vtkMRMLMarkupsDisplayNode *markupsDisplayNode)
 Set/Get the vtkMRMLMarkipsNode connected with this representation. More...
 
virtual void UpdateCenter ()
 
- 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 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

bool GetAllControlPointsVisible () override
 Convenience method. More...
 
ControlPointsPipeline2DGetControlPointsPipeline (int controlPointType)
 
double GetMaximumControlPointPickingDistance2 ()
 
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...
 
virtual void UpdateAllPointsAndLabelsFromMRML (double labelsOffset)
 
void UpdateControlPointSize () override
 
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)
 
 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])
 
void UpdateRelativeCoincidentTopologyOffsets (vtkMapper *mapper)
 
 vtkMRMLAbstractWidgetRepresentation ()
 
 ~vtkMRMLAbstractWidgetRepresentation () override
 

Protected Attributes

bool CenterVisibilityOnSlice
 
vtkSmartPointer< vtkIntArray > PointsVisibilityOnSlice
 
vtkSmartPointer< vtkPlane > SlicePlane
 
vtkSmartPointer< vtkTransform > WorldToSliceTransform
 
- Protected Attributes inherited from vtkSlicerMarkupsWidgetRepresentation
vtkTypeBool ClosedLoop
 
ControlPointsPipelineControlPoints [NumberOfControlPointTypes]
 
double ControlPointSize
 
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
enum  {
  Unselected, Selected, Active, Project,
  ProjectBack, NumberOfControlPointTypes
}
 

Detailed Description

Default representation for the slicer markups widget.

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

See also
vtkSlicerMarkupsWidgetRepresentation2D vtkMRMLAbstractWidget

Definition at line 49 of file vtkSlicerMarkupsWidgetRepresentation2D.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 53 of file vtkSlicerMarkupsWidgetRepresentation2D.h.

Constructor & Destructor Documentation

◆ vtkSlicerMarkupsWidgetRepresentation2D()

vtkSlicerMarkupsWidgetRepresentation2D::vtkSlicerMarkupsWidgetRepresentation2D ( )
protected

◆ ~vtkSlicerMarkupsWidgetRepresentation2D()

vtkSlicerMarkupsWidgetRepresentation2D::~vtkSlicerMarkupsWidgetRepresentation2D ( )
overrideprotected

Member Function Documentation

◆ CanInteract()

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

Position is displayed (slice) position.

Reimplemented from vtkSlicerMarkupsWidgetRepresentation.

◆ CanInteractWithLine()

void vtkSlicerMarkupsWidgetRepresentation2D::CanInteractWithLine ( vtkMRMLInteractionEventData interactionEventData,
int &  foundComponentType,
int &  foundComponentIndex,
double &  closestDistance2 
)

Checks if interaction with straight line between visible points is possible. Can be used on the output of CanInteract, as if no better component is found then the input is returned.

◆ GetActors()

void vtkSlicerMarkupsWidgetRepresentation2D::GetActors ( vtkPropCollection *  )
override

Methods to make this class behave as a vtkProp.

◆ GetAllControlPointsVisible()

bool vtkSlicerMarkupsWidgetRepresentation2D::GetAllControlPointsVisible ( )
overrideprotectedvirtual

Convenience method.

Reimplemented from vtkSlicerMarkupsWidgetRepresentation.

◆ GetClassName()

virtual const char* vtkSlicerMarkupsWidgetRepresentation2D::GetClassName ( )
virtual

◆ GetControlPointsPipeline()

ControlPointsPipeline2D* vtkSlicerMarkupsWidgetRepresentation2D::GetControlPointsPipeline ( int  controlPointType)
protected

◆ GetMaximumControlPointPickingDistance2()

double vtkSlicerMarkupsWidgetRepresentation2D::GetMaximumControlPointPickingDistance2 ( )
protected

◆ GetNthControlPointDisplayPosition()

int vtkSlicerMarkupsWidgetRepresentation2D::GetNthControlPointDisplayPosition ( int  n,
double  pos[2] 
)
overridevirtual

Get the nth node's position on the slice. Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting).

Reimplemented from vtkSlicerMarkupsWidgetRepresentation.

◆ GetNthControlPointViewVisibility()

virtual bool vtkSlicerMarkupsWidgetRepresentation2D::GetNthControlPointViewVisibility ( int  n)
virtual

Set the Nth node visibility in this view (markup visibility is enabled and markup is on current slice). Useful for non-regression tests that need to inspect internal state of the widget.

◆ GetSliceNode()

vtkMRMLSliceNode* vtkSlicerMarkupsWidgetRepresentation2D::GetSliceNode ( )
protected

Get MRML view node as slice view node.

◆ GetSliceToWorldCoordinates()

void vtkSlicerMarkupsWidgetRepresentation2D::GetSliceToWorldCoordinates ( const double  [2],
double  [3] 
)

◆ GetWidgetOpacity()

double vtkSlicerMarkupsWidgetRepresentation2D::GetWidgetOpacity ( int  controlPointType)
protected

◆ GetWorldToDisplayCoordinates() [1/2]

void vtkSlicerMarkupsWidgetRepresentation2D::GetWorldToDisplayCoordinates ( double  r,
double  a,
double  s,
double *  displayCoordinates 
)
protected

Convert display to world coordinates.

◆ GetWorldToDisplayCoordinates() [2/2]

void vtkSlicerMarkupsWidgetRepresentation2D::GetWorldToDisplayCoordinates ( double *  worldCoordinates,
double *  displayCoordinates 
)
protected

◆ GetWorldToSliceCoordinates()

void vtkSlicerMarkupsWidgetRepresentation2D::GetWorldToSliceCoordinates ( const double  worldPos[3],
double  slicePos[2] 
)

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkSlicerMarkupsWidgetRepresentation2D::HasTranslucentPolygonalGeometry ( )
override

◆ IsA()

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

◆ IsCenterDisplayableOnSlice()

virtual bool vtkSlicerMarkupsWidgetRepresentation2D::IsCenterDisplayableOnSlice ( vtkMRMLMarkupsNode node)
protectedvirtual

Check, if the point is displayable in the current slice geometry.

◆ IsControlPointDisplayableOnSlice()

virtual bool vtkSlicerMarkupsWidgetRepresentation2D::IsControlPointDisplayableOnSlice ( vtkMRMLMarkupsNode node,
int  pointIndex = 0 
)
protectedvirtual

Check, if the point is displayable in the current slice geometry.

◆ IsPointBehindSlice()

virtual bool vtkSlicerMarkupsWidgetRepresentation2D::IsPointBehindSlice ( vtkMRMLMarkupsNode node,
int  pointIndex = 0 
)
protectedvirtual

Check, if the point is behind in the current slice geometry.

◆ IsPointInFrontSlice()

virtual bool vtkSlicerMarkupsWidgetRepresentation2D::IsPointInFrontSlice ( vtkMRMLMarkupsNode node,
int  pointIndex = 0 
)
protectedvirtual

Check, if the point is in front in the current slice geometry.

◆ IsTypeOf()

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

◆ PrintSelf()

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

◆ ReleaseGraphicsResources()

void vtkSlicerMarkupsWidgetRepresentation2D::ReleaseGraphicsResources ( vtkWindow *  )
override

◆ RenderOpaqueGeometry()

int vtkSlicerMarkupsWidgetRepresentation2D::RenderOpaqueGeometry ( vtkViewport *  viewport)
override

◆ RenderOverlay()

int vtkSlicerMarkupsWidgetRepresentation2D::RenderOverlay ( vtkViewport *  viewport)
override

◆ RenderTranslucentPolygonalGeometry()

int vtkSlicerMarkupsWidgetRepresentation2D::RenderTranslucentPolygonalGeometry ( vtkViewport *  viewport)
override

◆ SafeDownCast()

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

◆ SetCenterSliceVisibility()

virtual void vtkSlicerMarkupsWidgetRepresentation2D::SetCenterSliceVisibility ( bool  visibility)
virtual

Set the center slice visibility (i.e. if it is on the slice).

◆ SetNthControlPointSliceVisibility()

virtual void vtkSlicerMarkupsWidgetRepresentation2D::SetNthControlPointSliceVisibility ( int  n,
bool  visibility 
)
virtual

Set the Nth node slice visibility (i.e. if it is on the slice).

◆ UpdateAllPointsAndLabelsFromMRML()

virtual void vtkSlicerMarkupsWidgetRepresentation2D::UpdateAllPointsAndLabelsFromMRML ( double  labelsOffset)
protectedvirtual

◆ UpdateControlPointSize()

void vtkSlicerMarkupsWidgetRepresentation2D::UpdateControlPointSize ( )
overrideprotectedvirtual

◆ UpdateDistanceColorMap()

void vtkSlicerMarkupsWidgetRepresentation2D::UpdateDistanceColorMap ( vtkDiscretizableColorTransferFunction *  colormap,
double  color[3] 
)
protected

◆ UpdateFromMRML()

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

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

Reimplemented from vtkSlicerMarkupsWidgetRepresentation.

◆ UpdatePlaneFromSliceNode()

void vtkSlicerMarkupsWidgetRepresentation2D::UpdatePlaneFromSliceNode ( )
protected

◆ UpdateViewScaleFactor()

void vtkSlicerMarkupsWidgetRepresentation2D::UpdateViewScaleFactor ( )
overrideprotectedvirtual

Member Data Documentation

◆ CenterVisibilityOnSlice

bool vtkSlicerMarkupsWidgetRepresentation2D::CenterVisibilityOnSlice
protected

Definition at line 153 of file vtkSlicerMarkupsWidgetRepresentation2D.h.

◆ PointsVisibilityOnSlice

vtkSmartPointer<vtkIntArray> vtkSlicerMarkupsWidgetRepresentation2D::PointsVisibilityOnSlice
protected

Definition at line 152 of file vtkSlicerMarkupsWidgetRepresentation2D.h.

◆ SlicePlane

vtkSmartPointer<vtkPlane> vtkSlicerMarkupsWidgetRepresentation2D::SlicePlane
protected

Definition at line 156 of file vtkSlicerMarkupsWidgetRepresentation2D.h.

◆ WorldToSliceTransform

vtkSmartPointer<vtkTransform> vtkSlicerMarkupsWidgetRepresentation2D::WorldToSliceTransform
protected

Definition at line 155 of file vtkSlicerMarkupsWidgetRepresentation2D.h.


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