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

Default representation for the plane widget. More...

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

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

Public Types

typedef vtkSlicerMarkupsWidgetRepresentation3D Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkSlicerMarkupsWidgetRepresentation3D
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
 
void CanInteractWithPlane (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 ()
 
bool GetTransformationReferencePoint (double referencePointWorld[3]) override
 Translation, rotation, scaling will happen around this position. More...
 
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
 
- Public Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation3D
bool AccuratePick (int x, int y, double pickPoint[3])
 
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...
 
double * GetBounds () override
 Return the bounds of the representation. More...
 
bool GetNthControlPointViewVisibility (int n)
 
virtual double GetOccludedRelativeOffset ()
 
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 SetOccludedRelativeOffset (double)
 
void SetRenderer (vtkRenderer *ren) 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. 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 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 GetNthControlPointDisplayPosition (int n, double pos[2])
 
virtual int GetNumberOfControlPoints ()
 Get number of control points. More...
 
virtual vtkPointPlacer * GetPointPlacer ()
 
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 UpdateCenter ()
 
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 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 vtkSlicerPlaneRepresentation3DNew ()
 Instantiate this class. More...
 
static vtkSlicerPlaneRepresentation3DSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation3D
static int IsTypeOf (const char *type)
 
static vtkSlicerMarkupsWidgetRepresentation3DSafeDownCast (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 BuildPlane ()
 
void UpdateInteractionPipeline () override
 Update the interaction pipeline. More...
 
 vtkSlicerPlaneRepresentation3D ()
 
 ~vtkSlicerPlaneRepresentation3D () override
 
- Protected Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation3D
ControlPointsPipeline3DGetControlPointsPipeline (int controlPointType)
 
double GetViewScaleFactorAtPosition (double positionWorld[3])
 
virtual void UpdateAllPointsAndLabelsFromMRML ()
 
void UpdateControlPointSize () override
 
virtual void UpdateNthPointAndLabelFromMRML (int n)
 
void UpdateRelativeCoincidentTopologyOffsets (vtkMapper *mapper, vtkMapper *occludedMapper)
 
virtual void UpdateRelativeCoincidentTopologyOffsets (vtkMapper *mapper)
 
void UpdateViewScaleFactor () override
 
 vtkSlicerMarkupsWidgetRepresentation3D ()
 
 ~vtkSlicerMarkupsWidgetRepresentation3D () override
 
- Protected Member Functions inherited from vtkSlicerMarkupsWidgetRepresentation
void BuildLine (vtkPolyData *linePolyData, bool displayPosition)
 
bool GetAllControlPointsSelected ()
 Convenience method. More...
 
virtual bool GetAllControlPointsVisible ()
 Convenience method. More...
 
double * GetWidgetColor (int controlPointType)
 
virtual void SetMarkupsNode (vtkMRMLMarkupsNode *markupsNode)
 
virtual void SetupInteractionPipeline ()
 
 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

vtkNew< vtkAppendPolyData > Append
 
vtkNew< vtkArrayCalculator > ArrowColorFilter
 
vtkNew< vtkArrowSource > ArrowFilter
 
vtkNew< vtkGlyph3D > ArrowGlypher
 
std::string LabelFormat
 
vtkNew< vtkActor > PlaneActor
 
vtkNew< vtkLookupTable > PlaneColorLUT
 
vtkNew< vtkArrayCalculator > PlaneFillColorFilter
 
vtkNew< vtkPlaneSource > PlaneFillFilter
 
vtkNew< vtkPolyDataMapper > PlaneMapper
 
vtkNew< vtkActor > PlaneOccludedActor
 
vtkNew< vtkPolyDataMapper > PlaneOccludedMapper
 
vtkNew< vtkArrayCalculator > PlaneOutlineColorFilter
 
vtkNew< vtkTubeFilter > PlaneOutlineFilter
 
- Protected Attributes inherited from vtkSlicerMarkupsWidgetRepresentation3D
vtkSmartPointer< vtkCellPicker > AccuratePicker
 
bool HideTextActorIfAllPointsOccluded
 
double OccludedRelativeOffset
 
bool TextActorOccluded
 
double TextActorPositionWorld [3]
 
- 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
vtkSlicerMarkupsWidgetRepresentation3D vtkMRMLAbstractWidget

Definition at line 51 of file vtkSlicerPlaneRepresentation3D.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 58 of file vtkSlicerPlaneRepresentation3D.h.

Constructor & Destructor Documentation

◆ vtkSlicerPlaneRepresentation3D()

vtkSlicerPlaneRepresentation3D::vtkSlicerPlaneRepresentation3D ( )
protected

◆ ~vtkSlicerPlaneRepresentation3D()

vtkSlicerPlaneRepresentation3D::~vtkSlicerPlaneRepresentation3D ( )
overrideprotected

Member Function Documentation

◆ BuildPlane()

void vtkSlicerPlaneRepresentation3D::BuildPlane ( )
protected

◆ CanInteract()

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

Return found component type (as vtkMRMLMarkupsDisplayNode::ComponentType). closestDistance2 is the squared distance in display coordinates from the closest position where interaction is possible. componentIndex returns index of the found component (e.g., if control point is found then control point index is returned).

Reimplemented from vtkSlicerMarkupsWidgetRepresentation3D.

◆ CanInteractWithPlane()

void vtkSlicerPlaneRepresentation3D::CanInteractWithPlane ( vtkMRMLInteractionEventData interactionEventData,
int &  foundComponentType,
int &  foundComponentIndex,
double &  closestDistance2 
)

◆ GetActors()

void vtkSlicerPlaneRepresentation3D::GetActors ( vtkPropCollection *  )
override

Methods to make this class behave as a vtkProp.

◆ GetBounds()

double* vtkSlicerPlaneRepresentation3D::GetBounds ( )
override

Return the bounds of the representation.

◆ GetClassName()

virtual const char* vtkSlicerPlaneRepresentation3D::GetClassName ( )
virtual

◆ GetTransformationReferencePoint()

bool vtkSlicerPlaneRepresentation3D::GetTransformationReferencePoint ( double  referencePointWorld[3])
overridevirtual

Translation, rotation, scaling will happen around this position.

Reimplemented from vtkSlicerMarkupsWidgetRepresentation.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkSlicerPlaneRepresentation3D::HasTranslucentPolygonalGeometry ( )
override

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkSlicerPlaneRepresentation3D* vtkSlicerPlaneRepresentation3D::New ( )
static

Instantiate this class.

◆ PrintSelf()

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

◆ ReleaseGraphicsResources()

void vtkSlicerPlaneRepresentation3D::ReleaseGraphicsResources ( vtkWindow *  )
override

◆ RenderOpaqueGeometry()

int vtkSlicerPlaneRepresentation3D::RenderOpaqueGeometry ( vtkViewport *  viewport)
override

◆ RenderOverlay()

int vtkSlicerPlaneRepresentation3D::RenderOverlay ( vtkViewport *  viewport)
override

◆ RenderTranslucentPolygonalGeometry()

int vtkSlicerPlaneRepresentation3D::RenderTranslucentPolygonalGeometry ( vtkViewport *  viewport)
override

◆ SafeDownCast()

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

◆ UpdateFromMRML()

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

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

Reimplemented from vtkSlicerMarkupsWidgetRepresentation3D.

◆ UpdateInteractionPipeline()

void vtkSlicerPlaneRepresentation3D::UpdateInteractionPipeline ( )
overrideprotectedvirtual

Update the interaction pipeline.

Reimplemented from vtkSlicerMarkupsWidgetRepresentation3D.

Member Data Documentation

◆ Append

vtkNew<vtkAppendPolyData> vtkSlicerPlaneRepresentation3D::Append
protected

Definition at line 96 of file vtkSlicerPlaneRepresentation3D.h.

◆ ArrowColorFilter

vtkNew<vtkArrayCalculator> vtkSlicerPlaneRepresentation3D::ArrowColorFilter
protected

Definition at line 93 of file vtkSlicerPlaneRepresentation3D.h.

◆ ArrowFilter

vtkNew<vtkArrowSource> vtkSlicerPlaneRepresentation3D::ArrowFilter
protected

Definition at line 90 of file vtkSlicerPlaneRepresentation3D.h.

◆ ArrowGlypher

vtkNew<vtkGlyph3D> vtkSlicerPlaneRepresentation3D::ArrowGlypher
protected

Definition at line 91 of file vtkSlicerPlaneRepresentation3D.h.

◆ LabelFormat

std::string vtkSlicerPlaneRepresentation3D::LabelFormat
protected

Definition at line 106 of file vtkSlicerPlaneRepresentation3D.h.

◆ PlaneActor

vtkNew<vtkActor> vtkSlicerPlaneRepresentation3D::PlaneActor
protected

Definition at line 98 of file vtkSlicerPlaneRepresentation3D.h.

◆ PlaneColorLUT

vtkNew<vtkLookupTable> vtkSlicerPlaneRepresentation3D::PlaneColorLUT
protected

Definition at line 104 of file vtkSlicerPlaneRepresentation3D.h.

◆ PlaneFillColorFilter

vtkNew<vtkArrayCalculator> vtkSlicerPlaneRepresentation3D::PlaneFillColorFilter
protected

Definition at line 95 of file vtkSlicerPlaneRepresentation3D.h.

◆ PlaneFillFilter

vtkNew<vtkPlaneSource> vtkSlicerPlaneRepresentation3D::PlaneFillFilter
protected

Definition at line 89 of file vtkSlicerPlaneRepresentation3D.h.

◆ PlaneMapper

vtkNew<vtkPolyDataMapper> vtkSlicerPlaneRepresentation3D::PlaneMapper
protected

Definition at line 101 of file vtkSlicerPlaneRepresentation3D.h.

◆ PlaneOccludedActor

vtkNew<vtkActor> vtkSlicerPlaneRepresentation3D::PlaneOccludedActor
protected

Definition at line 99 of file vtkSlicerPlaneRepresentation3D.h.

◆ PlaneOccludedMapper

vtkNew<vtkPolyDataMapper> vtkSlicerPlaneRepresentation3D::PlaneOccludedMapper
protected

Definition at line 102 of file vtkSlicerPlaneRepresentation3D.h.

◆ PlaneOutlineColorFilter

vtkNew<vtkArrayCalculator> vtkSlicerPlaneRepresentation3D::PlaneOutlineColorFilter
protected

Definition at line 94 of file vtkSlicerPlaneRepresentation3D.h.

◆ PlaneOutlineFilter

vtkNew<vtkTubeFilter> vtkSlicerPlaneRepresentation3D::PlaneOutlineFilter
protected

Definition at line 92 of file vtkSlicerPlaneRepresentation3D.h.


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