Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
Loading...
Searching...
No Matches
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.
 
- Public Types inherited from vtkSlicerMarkupsWidgetRepresentation
enum  {
  Unselected , Selected , Active , Project ,
  ProjectBack , NumberOfControlPointTypes
}
 
typedef vtkMRMLAbstractWidgetRepresentation Superclass
 Standard methods for instances of this class.
 
- Public Types inherited from vtkMRMLAbstractWidgetRepresentation
typedef vtkProp Superclass
 Standard methods for instances of this class.
 

Public Member Functions

void CanInteract (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2) override
 Position is displayed (slice) position.
 
void CanInteractWithLine (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2)
 
void GetActors (vtkPropCollection *) override
 Methods to make this class behave as a vtkProp.
 
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).
 
virtual void SetNthControlPointSliceVisibility (int n, bool visibility)
 Set the Nth node slice visibility (i.e. if it is on the slice).
 
void UpdateFromMRMLInternal (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)
 
void GetActors (vtkPropCollection *) override
 Methods to make this class behave as a vtkProp.
 
virtual vtkPolyData * GetControlPointsPolyData (int controlPointType)
 
virtual vtkPolyData * GetLabelControlPointsPolyData (int pipeline)
 
virtual vtkStringArray * GetLabels (int pipeline)
 
virtual vtkMRMLMarkupsDisplayNodeGetMarkupsDisplayNode ()
 
virtual vtkMRMLMarkupsNodeGetMarkupsNode ()
 
virtual vtkMRMLMarkupsNode::ControlPointGetNthControlPoint (int n)
 Get the nth control point.
 
virtual int GetNumberOfControlPoints ()
 Get number of control points.
 
virtual vtkPointPlacer * GetPointPlacer ()
 
virtual bool GetTransformationReferencePoint (double referencePointWorld[3])
 Translation, rotation, scaling will happen around this position.
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 
bool IsDisplayable ()
 
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 vtkMRMLMarkupsNode connected with this representation.
 
virtual void UpdateCenterOfRotation ()
 Compute the center of rotation and update it in the Markups node.
 
void UpdateFromMRML (vtkMRMLNode *caller, unsigned long event, void *callData=nullptr) override
 Update the representation from markups node.
 
- Public Member Functions inherited from vtkMRMLAbstractWidgetRepresentation
virtual void AlwaysOnTopOff ()
 
virtual void AlwaysOnTopOn ()
 
void GetActors (vtkPropCollection *) override
 
void GetActors2D (vtkPropCollection *) override
 
virtual bool GetAlwaysOnTop ()
 
virtual double GetAlwaysOnTopRelativeOffsetFactor ()
 
virtual double GetAlwaysOnTopRelativeOffsetUnits ()
 
virtual vtkMRMLApplicationLogicGetApplicationLogic ()
 
double * GetBounds () VTK_SIZEHINT(6) override
 
virtual bool GetNeedToRender ()
 
virtual double GetPickingTolerance ()
 
virtual vtkRenderer * GetRenderer ()
 
double GetScreenScaleFactor ()
 Convenience method for getting screen scale factor from the associated view node.
 
virtual vtkMRMLAbstractViewNodeGetViewNode ()
 
void GetVolumes (vtkPropCollection *) override
 
vtkTypeBool HasTranslucentPolygonalGeometry () override
 
virtual void NeedToRenderOff ()
 
virtual void NeedToRenderOn ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 
int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
virtual void SetAlwaysOnTop (bool)
 
virtual void SetAlwaysOnTopRelativeOffsetFactor (double)
 
virtual void SetAlwaysOnTopRelativeOffsetUnits (double)
 
virtual void SetApplicationLogic (vtkMRMLApplicationLogic *appLogic)
 
virtual void SetNeedToRender (bool)
 
virtual void SetPickingTolerance (double)
 
virtual void SetRenderer (vtkRenderer *ren)
 
virtual void SetViewNode (vtkMRMLAbstractViewNode *viewNode)
 

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.
 
ControlPointsPipeline2DGetControlPointsPipeline (int controlPointType)
 
double GetMaximumControlPointPickingDistance2 ()
 
vtkMRMLSliceNodeGetSliceNode ()
 Get MRML view node as slice view node.
 
double GetWidgetOpacity (int controlPointType)
 
void GetWorldToDisplayCoordinates (double *worldCoordinates, double *displayCoordinates)
 
void GetWorldToDisplayCoordinates (double r, double a, double s, double *displayCoordinates)
 Convert display to world coordinates.
 
virtual bool IsCenterDisplayableOnSlice (vtkMRMLMarkupsNode *node)
 Check, if the point is displayable in the current slice geometry.
 
virtual bool IsControlPointDisplayableOnSlice (vtkMRMLMarkupsNode *node, int pointIndex=0)
 Check, if the point is displayable in the current slice geometry.
 
virtual bool IsPointBehindSlice (vtkMRMLMarkupsNode *node, int pointIndex=0)
 Check, if the point is behind in the current slice geometry.
 
virtual bool IsPointInFrontSlice (vtkMRMLMarkupsNode *node, int pointIndex=0)
 Check, if the point is in front in the current slice geometry.
 
bool IsRepresentationIntersectingSlice (vtkPolyData *representation, const char *arrayName)
 Check if the representation polydata intersects the slice.
 
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.
 
double * GetWidgetColor (int controlPointType) VTK_SIZEHINT(3)
 
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])
 
virtual void UpdateRelativeCoincidentTopologyOffsets (vtkMapper *mapper)
 
 vtkMRMLAbstractWidgetRepresentation ()
 
 ~vtkMRMLAbstractWidgetRepresentation () override
 

Protected Attributes

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
 
vtkWeakPointer< vtkMRMLMarkupsDisplayNodeMarkupsDisplayNode
 
vtkWeakPointer< vtkMRMLMarkupsNodeMarkupsNode
 
vtkTimeStamp MarkupsTransformModifiedTime
 
vtkSmartPointer< vtkPointPlacer > PointPlacer
 
double ScreenSizePixel
 
vtkSmartPointer< vtkTextActor > TextActor
 
double ViewScaleFactorMmPerPixel
 
- Protected Attributes inherited from vtkMRMLAbstractWidgetRepresentation
bool AlwaysOnTop
 
double AlwaysOnTopRelativeOffsetFactor { 0.0 }
 Relative offset used for rendering occluded actors.
 
double AlwaysOnTopRelativeOffsetUnits { -66000.0 }
 
vtkWeakPointer< vtkMRMLApplicationLogicApplicationLogic
 
double Bounds [6]
 Temporary variable to store GetBounds() result.
 
bool NeedToRender
 
double PickingTolerance
 
vtkWeakPointer< vtkRenderer > Renderer
 The renderer in which this widget is placed.
 
vtkWeakPointer< vtkMRMLAbstractViewNodeViewNode
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation
static int GetGlyphTypeSourceFromDisplay (int glyphTypeDisplay)
 

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.

Reimplemented in vtkSlicerPlaneRepresentation2D, and vtkSlicerROIRepresentation2D.

◆ 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 * worldCoordinates,
double * displayCoordinates )
protected

◆ GetWorldToDisplayCoordinates() [2/2]

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

Convert display to world coordinates.

◆ 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.

◆ IsRepresentationIntersectingSlice()

bool vtkSlicerMarkupsWidgetRepresentation2D::IsRepresentationIntersectingSlice ( vtkPolyData * representation,
const char * arrayName )
protected

Check if the representation polydata intersects the slice.

◆ 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()

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

◆ UpdateFromMRMLInternal()

void vtkSlicerMarkupsWidgetRepresentation2D::UpdateFromMRMLInternal ( 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.

Reimplemented in vtkSlicerPlaneRepresentation2D, and vtkSlicerROIRepresentation2D.

◆ UpdatePlaneFromSliceNode()

void vtkSlicerMarkupsWidgetRepresentation2D::UpdatePlaneFromSliceNode ( )
protected

◆ UpdateViewScaleFactor()

void vtkSlicerMarkupsWidgetRepresentation2D::UpdateViewScaleFactor ( )
overrideprotectedvirtual

Member Data Documentation

◆ AnyPointVisibilityOnSlice

bool vtkSlicerMarkupsWidgetRepresentation2D::AnyPointVisibilityOnSlice = { false }
protected

Definition at line 157 of file vtkSlicerMarkupsWidgetRepresentation2D.h.

◆ CenterVisibilityOnSlice

bool vtkSlicerMarkupsWidgetRepresentation2D::CenterVisibilityOnSlice = { false }
protected

Definition at line 156 of file vtkSlicerMarkupsWidgetRepresentation2D.h.

◆ PointsVisibilityOnSlice

vtkSmartPointer<vtkIntArray> vtkSlicerMarkupsWidgetRepresentation2D::PointsVisibilityOnSlice
protected

Definition at line 155 of file vtkSlicerMarkupsWidgetRepresentation2D.h.

◆ SlicePlane

vtkSmartPointer<vtkPlane> vtkSlicerMarkupsWidgetRepresentation2D::SlicePlane
protected

Definition at line 160 of file vtkSlicerMarkupsWidgetRepresentation2D.h.

◆ WorldToSliceTransform

vtkSmartPointer<vtkTransform> vtkSlicerMarkupsWidgetRepresentation2D::WorldToSliceTransform
protected

Definition at line 159 of file vtkSlicerMarkupsWidgetRepresentation2D.h.


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