Abstract representation for the transform handle widgets. More...

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

Inheritance diagram for vtkSlicerMarkupsInteractionWidgetRepresentation:

[legend]

Collaboration diagram for vtkSlicerMarkupsInteractionWidgetRepresentation:

[legend]

Public Types
typedef vtkMRMLInteractionWidgetRepresentation	Superclass

Public Types inherited from vtkMRMLInteractionWidgetRepresentation
enum	{ InteractionNone , InteractionTranslationHandle , InteractionRotationHandle , InteractionScaleHandle , Interaction_Last }

enum	{ GlyphArrow , GlyphCircle , GlyphRing }

typedef vtkMRMLAbstractWidgetRepresentation	Superclass

Public Types inherited from vtkMRMLAbstractWidgetRepresentation
typedef vtkProp	Superclass
	Standard methods for instances of this class.

Public Member Functions
bool	AddScaleEdgeIntersection (int pointIndex, vtkIdTypeArray visibilityArray, vtkPoints scaleHandleArray, double sliceNormal[3], double sliceOrigin[3], double edgePoint[3], double edgeVector[3])

void	CreateScaleHandles () override

int	GetActiveComponentIndex () override

int	GetActiveComponentType () override

bool	GetApplyScaleToPosition (int type, int index) override
	Get if the view scaling should be applied to the position of the handle.

virtual const char *	GetClassName ()

virtual vtkMRMLMarkupsDisplayNode *	GetDisplayNode ()

void	GetHandleColor (int type, int index, double color[4]) override

bool	GetHandleVisibility (int type, int index) override
	Get the visibility of the specified handle.

void	GetInteractionHandleAxisLocal (int type, int index, double axis_Local[3]) override
	Get the axis for the handle specified by the index in local coordinates.

void	GetInteractionHandlePositionWorld (int type, int index, double positionWorld[3]) override

double	GetInteractionScalePercent () override

bool	GetInteractionSizeAbsolute () override

double	GetInteractionSizeMm () override

virtual vtkMRMLMarkupsNode *	GetMarkupsNode ()

virtual int	InteractionComponentToMarkupsComponent (int)

virtual int	IsA (const char *type)

bool	IsDisplayable () override

virtual int	MarkupsComponentToInteractionComponent (int)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetActiveComponentIndex (int type) override

void	SetActiveComponentType (int type) override

virtual void	SetDisplayNode (vtkMRMLMarkupsDisplayNode *displayNode)

virtual void	UpdateHandleToWorldTransform ()

void	UpdateHandleToWorldTransform (vtkTransform *handleToWorldTransform) override

void	UpdateInteractionPipeline () override
	Update the interaction pipeline.

virtual void	UpdatePlaneScaleHandles ()

virtual void	UpdateROIScaleHandles ()

virtual void	UpdateROIScaleHandles2D ()

virtual void	UpdateROIScaleHandles3D ()

Public Member Functions inherited from vtkMRMLInteractionWidgetRepresentation
virtual void	CanInteract (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2)

void	GetActors (vtkPropCollection *) override
	Methods to make this class behave as a vtkProp.

virtual int	GetHandleGlyphType (int type, int index)
	Get the type of glyph (Arrow, Circle, Ring, etc.) of the specified handle.

virtual double	GetHandleOpacity (int type, int index)
	Get the opacity of the specified handle.

virtual vtkTransform *	GetHandleToWorldTransform ()

virtual bool	GetInteracting ()

vtkProp *	GetInteractionActor ()
	Returns the actor for the interaction widget.

virtual void	GetInteractionHandleAxisWorld (int type, int index, double axis[3])
	Get the axis for the handle specified by the index.

virtual void	GetInteractionHandleOriginWorld (double origin[3])
	Get the origin of the interaction handle widget.

virtual void	GetInteractionHandlePositionLocal (int type, int index, double position[3])

virtual double	GetMaximumHandlePickingDistance2 ()

virtual int	GetNumberOfHandles ()

virtual int	GetNumberOfHandles (int type)

virtual vtkPointPlacer *	GetPointPlacer ()

virtual vtkMRMLSliceNode *	GetSliceNode ()

virtual void	GetSliceToWorldCoordinates (const double slicePos[2], double worldPos[3])

virtual bool	GetTransformationReferencePoint (double referencePointWorld[3])
	Translation, rotation, scaling will happen around this position.

vtkTypeBool	HasTranslucentPolygonalGeometry () override

virtual void	InteractingOff ()

virtual void	InteractingOn ()

void	ReleaseGraphicsResources (vtkWindow *) override

int	RenderOpaqueGeometry (vtkViewport *viewport) override

int	RenderOverlay (vtkViewport *viewport) override

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override

virtual void	SetInteracting (bool)

void	UpdateFromMRML (vtkMRMLNode caller, unsigned long event, void callData=nullptr) override
	Update the representation from display node.

virtual void	UpdateHandlePolyData ()

virtual void	UpdateSlicePlaneFromSliceNode ()

void	PrintSelf (ostream &os, vtkIndent indent) override

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 vtkMRMLApplicationLogic *	GetApplicationLogic ()

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 vtkMRMLAbstractViewNode *	GetViewNode ()

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 vtkSlicerMarkupsInteractionWidgetRepresentation *	New ()

static vtkSlicerMarkupsInteractionWidgetRepresentation *	SafeDownCast (vtkObject *o)

static int	IsTypeOf (const char *type)

static vtkMRMLInteractionWidgetRepresentation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLAbstractWidgetRepresentation
static int	IsTypeOf (const char *type)

static vtkMRMLAbstractWidgetRepresentation *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkSlicerMarkupsInteractionWidgetRepresentation ()

	~vtkSlicerMarkupsInteractionWidgetRepresentation () override

Protected Member Functions inherited from vtkMRMLInteractionWidgetRepresentation
virtual void	CanInteractWithArrowHandle (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2, HandleInfo &handleInfo)

virtual void	CanInteractWithCircleHandle (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2, HandleInfo &handleInfo)

virtual void	CanInteractWithRingHandle (vtkMRMLInteractionEventData *interactionEventData, int &foundComponentType, int &foundComponentIndex, double &closestDistance2, HandleInfo &handleInfo)

virtual void	CreateRotationHandles ()

virtual void	CreateTranslationHandles ()

virtual HandleInfo	GetHandleInfo (int type, int index)

virtual HandleInfoList	GetHandleInfoList ()

virtual vtkPolyData *	GetHandlePolydata (int type)

virtual void	GetHandleToCameraVectorWorld (double handlePosition_World[3], double normal_World[3])

virtual void	InitializePipeline ()

virtual void	OrthoganalizeTransform (vtkTransform *transform)
	Orthogonalize the transform axes. The Z-axis will not be changed.

virtual void	SetupInteractionPipeline ()

virtual void	SetWidgetScale (double scale)
	Set the scale of the interaction handles in world coordinates.

virtual void	UpdateHandleColors ()

virtual int	UpdateHandleColors (int type, int startIndex)

virtual void	UpdateHandleOrientation ()

virtual void	UpdateHandleSize ()

virtual void	UpdateRotationHandleOrientation ()

virtual void	UpdateScaleHandleOrientation ()

virtual void	UpdateTranslationHandleOrientation ()

virtual void	UpdateViewScaleFactor ()
	Calculate view size and scale factor.

	vtkMRMLInteractionWidgetRepresentation ()

	~vtkMRMLInteractionWidgetRepresentation () 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< vtkMRMLMarkupsDisplayNode >	DisplayNode { nullptr }

Protected Attributes inherited from vtkMRMLInteractionWidgetRepresentation
double	EndFadeAngleDegrees { 8.0 }
	The angle between the camera and the interaction axis at which point the interaction handle is completely faded out.

bool	Interacting { false }

double	InteractionSize { 1.0 }

InteractionPipeline *	Pipeline

vtkSmartPointer< vtkPointPlacer >	PointPlacer

double	ScreenSizePixel

vtkSmartPointer< vtkPlane >	SlicePlane

double	StartFadeAngleDegrees { 10.0 }
	The angle between the camera and the interaction axis at which point the interaction handle starts to fade out.

double	ViewScaleFactorMmPerPixel

double	WidgetScale { 1.0 }

Protected Attributes inherited from vtkMRMLAbstractWidgetRepresentation
bool	AlwaysOnTop

double	AlwaysOnTopRelativeOffsetFactor { 0.0 }
	Relative offset used for rendering occluded actors.

double	AlwaysOnTopRelativeOffsetUnits { -66000.0 }

vtkWeakPointer< vtkMRMLApplicationLogic >	ApplicationLogic

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< vtkMRMLAbstractViewNode >	ViewNode

Additional Inherited Members
Protected Types inherited from vtkMRMLInteractionWidgetRepresentation
typedef std::vector< HandleInfo >	HandleInfoList
	Get the list of info for all interaction handles.

Detailed Description

Abstract representation for the transform handle widgets.

See also: vtkMRMLInteractionWidgetRepresentation

Definition at line 40 of file vtkSlicerMarkupsInteractionWidgetRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLInteractionWidgetRepresentation vtkSlicerMarkupsInteractionWidgetRepresentation::Superclass

Standard VTK class macros.

Definition at line 52 of file vtkSlicerMarkupsInteractionWidgetRepresentation.h.

Constructor & Destructor Documentation

◆ vtkSlicerMarkupsInteractionWidgetRepresentation()

vtkSlicerMarkupsInteractionWidgetRepresentation::vtkSlicerMarkupsInteractionWidgetRepresentation ( )

protected

◆ ~vtkSlicerMarkupsInteractionWidgetRepresentation()

vtkSlicerMarkupsInteractionWidgetRepresentation::~vtkSlicerMarkupsInteractionWidgetRepresentation ( )

overrideprotected

Member Function Documentation

◆ AddScaleEdgeIntersection()

bool vtkSlicerMarkupsInteractionWidgetRepresentation::AddScaleEdgeIntersection	(	int	pointIndex,
		vtkIdTypeArray *	visibilityArray,
		vtkPoints *	scaleHandleArray,
		double	sliceNormal[3],
		double	sliceOrigin[3],
		double	edgePoint[3],
		double	edgeVector[3] )

◆ CreateScaleHandles()

void vtkSlicerMarkupsInteractionWidgetRepresentation::CreateScaleHandles ( )

overridevirtual

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetActiveComponentIndex()

int vtkSlicerMarkupsInteractionWidgetRepresentation::GetActiveComponentIndex ( )

overridevirtual

Implements vtkMRMLInteractionWidgetRepresentation.

◆ GetActiveComponentType()

int vtkSlicerMarkupsInteractionWidgetRepresentation::GetActiveComponentType ( )

overridevirtual

Implements vtkMRMLInteractionWidgetRepresentation.

◆ GetApplyScaleToPosition()

bool vtkSlicerMarkupsInteractionWidgetRepresentation::GetApplyScaleToPosition	(	int	type,
		int	index )

overridevirtual

Get if the view scaling should be applied to the position of the handle.

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetClassName()

virtual const char * vtkSlicerMarkupsInteractionWidgetRepresentation::GetClassName ( )

virtual

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetDisplayNode()

virtual vtkMRMLMarkupsDisplayNode * vtkSlicerMarkupsInteractionWidgetRepresentation::GetDisplayNode ( )

virtual

◆ GetHandleColor()

void vtkSlicerMarkupsInteractionWidgetRepresentation::GetHandleColor	(	int	type,
		int	index,
		double	color[4] )

overridevirtual

Get the color of the specified handle Type is specified using InteractionType enum

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetHandleVisibility()

bool vtkSlicerMarkupsInteractionWidgetRepresentation::GetHandleVisibility	(	int	type,
		int	index )

overridevirtual

Get the visibility of the specified handle.

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetInteractionHandleAxisLocal()

void vtkSlicerMarkupsInteractionWidgetRepresentation::GetInteractionHandleAxisLocal	(	int	type,
		int	index,
		double	axis[3] )

overridevirtual

Get the axis for the handle specified by the index in local coordinates.

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetInteractionHandlePositionWorld()

void vtkSlicerMarkupsInteractionWidgetRepresentation::GetInteractionHandlePositionWorld	(	int	type,
		int	index,
		double	position[3] )

overridevirtual

Get the position of the interaction handle in world coordinates Type is specified using vtkMRMLInteractionDisplayNode::ComponentType

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetInteractionScalePercent()

double vtkSlicerMarkupsInteractionWidgetRepresentation::GetInteractionScalePercent ( )

overridevirtual

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetInteractionSizeAbsolute()

bool vtkSlicerMarkupsInteractionWidgetRepresentation::GetInteractionSizeAbsolute ( )

overridevirtual

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetInteractionSizeMm()

double vtkSlicerMarkupsInteractionWidgetRepresentation::GetInteractionSizeMm ( )

overridevirtual

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ GetMarkupsNode()

virtual vtkMRMLMarkupsNode * vtkSlicerMarkupsInteractionWidgetRepresentation::GetMarkupsNode ( )

virtual

◆ InteractionComponentToMarkupsComponent()

virtual int vtkSlicerMarkupsInteractionWidgetRepresentation::InteractionComponentToMarkupsComponent ( int )

virtual

◆ IsA()

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

virtual

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ IsDisplayable()

bool vtkSlicerMarkupsInteractionWidgetRepresentation::IsDisplayable ( )

overridevirtual

Returns true if the representation is displayable in the current view. It takes into account current view node's display node and parent folder's visibility.

Implements vtkMRMLInteractionWidgetRepresentation.

◆ IsTypeOf()

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

static

◆ MarkupsComponentToInteractionComponent()

virtual int vtkSlicerMarkupsInteractionWidgetRepresentation::MarkupsComponentToInteractionComponent ( int )

virtual

◆ New()

static vtkSlicerMarkupsInteractionWidgetRepresentation * vtkSlicerMarkupsInteractionWidgetRepresentation::New ( )

static

Instantiate this class.

◆ PrintSelf()

void vtkSlicerMarkupsInteractionWidgetRepresentation::PrintSelf	(	ostream &	os,
		vtkIndent	indent )

override

◆ SafeDownCast()

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

static

◆ SetActiveComponentIndex()

void vtkSlicerMarkupsInteractionWidgetRepresentation::SetActiveComponentIndex ( int type )

overridevirtual

Implements vtkMRMLInteractionWidgetRepresentation.

◆ SetActiveComponentType()

void vtkSlicerMarkupsInteractionWidgetRepresentation::SetActiveComponentType ( int type )

overridevirtual

Implements vtkMRMLInteractionWidgetRepresentation.

◆ SetDisplayNode()

virtual void vtkSlicerMarkupsInteractionWidgetRepresentation::SetDisplayNode ( vtkMRMLMarkupsDisplayNode * displayNode )

virtual

◆ UpdateHandleToWorldTransform() [1/2]

virtual void vtkMRMLInteractionWidgetRepresentation::UpdateHandleToWorldTransform ( )

virtual

Update HandleToWorldTransform. This controls the position and orientation of the interaction handles.

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ UpdateHandleToWorldTransform() [2/2]

void vtkSlicerMarkupsInteractionWidgetRepresentation::UpdateHandleToWorldTransform ( vtkTransform * handleToWorldTransform )

overridevirtual

Implements vtkMRMLInteractionWidgetRepresentation.

◆ UpdateInteractionPipeline()

void vtkSlicerMarkupsInteractionWidgetRepresentation::UpdateInteractionPipeline ( )

overridevirtual

Update the interaction pipeline.

Reimplemented from vtkMRMLInteractionWidgetRepresentation.

◆ UpdatePlaneScaleHandles()

virtual void vtkSlicerMarkupsInteractionWidgetRepresentation::UpdatePlaneScaleHandles ( )

virtual

◆ UpdateROIScaleHandles()

virtual void vtkSlicerMarkupsInteractionWidgetRepresentation::UpdateROIScaleHandles ( )

virtual

◆ UpdateROIScaleHandles2D()

virtual void vtkSlicerMarkupsInteractionWidgetRepresentation::UpdateROIScaleHandles2D ( )

virtual

◆ UpdateROIScaleHandles3D()

virtual void vtkSlicerMarkupsInteractionWidgetRepresentation::UpdateROIScaleHandles3D ( )

virtual

Member Data Documentation

◆ DisplayNode

vtkSmartPointer<vtkMRMLMarkupsDisplayNode> vtkSlicerMarkupsInteractionWidgetRepresentation::DisplayNode { nullptr }

protected

Definition at line 106 of file vtkSlicerMarkupsInteractionWidgetRepresentation.h.

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

Modules/Loadable/Markups/VTKWidgets/vtkSlicerMarkupsInteractionWidgetRepresentation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSlicerMarkupsInteractionWidgetRepresentation()

◆ ~vtkSlicerMarkupsInteractionWidgetRepresentation()

Member Function Documentation

◆ AddScaleEdgeIntersection()

◆ CreateScaleHandles()

◆ GetActiveComponentIndex()

◆ GetActiveComponentType()

◆ GetApplyScaleToPosition()

◆ GetClassName()

◆ GetDisplayNode()

◆ GetHandleColor()

◆ GetHandleVisibility()

◆ GetInteractionHandleAxisLocal()

◆ GetInteractionHandlePositionWorld()

◆ GetInteractionScalePercent()

◆ GetInteractionSizeAbsolute()

◆ GetInteractionSizeMm()

◆ GetMarkupsNode()

◆ InteractionComponentToMarkupsComponent()

◆ IsA()

◆ IsDisplayable()

◆ IsTypeOf()

◆ MarkupsComponentToInteractionComponent()

◆ New()

◆ PrintSelf()

◆ SafeDownCast()

◆ SetActiveComponentIndex()

◆ SetActiveComponentType()

◆ SetDisplayNode()

◆ UpdateHandleToWorldTransform() [1/2]

◆ UpdateHandleToWorldTransform() [2/2]

◆ UpdateInteractionPipeline()

◆ UpdatePlaneScaleHandles()

◆ UpdateROIScaleHandles()

◆ UpdateROIScaleHandles2D()

◆ UpdateROIScaleHandles3D()

Member Data Documentation

◆ DisplayNode