Geometry for a reslice cursor. More...

#include <vtkResliceCursor.h>

Inheritance diagram for vtkResliceCursor:

Collaboration diagram for vtkResliceCursor:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkResliceCursor *	NewInstance () const

virtual vtkPolyData *	GetPolyData ()
	Get the 3D PolyData representation.

virtual vtkPolyData *	GetCenterlineAxisPolyData (int axis)
	Get the slab and centerline polydata along an axis.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Printself method.

virtual vtkPlane *	GetPlane (int n)
	Get the planes that represent normals along the X, Y and Z.

virtual void	Update ()
	Build the polydata.

virtual double *	GetXViewUp ()
	Get/Set the view up.

virtual void	GetXViewUp (double &, double &, double &)

virtual void	GetXViewUp (double[3])

virtual double *	GetYViewUp ()

virtual void	GetYViewUp (double &, double &, double &)

virtual void	GetYViewUp (double[3])

virtual double *	GetZViewUp ()

virtual void	GetZViewUp (double &, double &, double &)

virtual void	GetZViewUp (double[3])

virtual void	SetXViewUp (double, double, double)

virtual void	SetXViewUp (double[3])

virtual void	SetYViewUp (double, double, double)

virtual void	SetYViewUp (double[3])

virtual void	SetZViewUp (double, double, double)

virtual void	SetZViewUp (double[3])

double *	GetViewUp (int i)

vtkMTimeType	GetMTime () override
	Get the MTime.

virtual void	Reset ()
	Reset the cursor to the default position, ie with the axes, normal to each other and axis aligned and with the cursor pointed at the center of the image.


virtual void	SetImage (vtkImageData *)
	Set the image (3D) that we are slicing.

virtual vtkImageData *	GetImage ()
	Set the image (3D) that we are slicing.


virtual void	SetCenter (double, double, double)
	Set/Get the cente of the reslice cursor.

virtual void	SetCenter (double center[3])
	Set/Get the cente of the reslice cursor.

virtual double *	GetCenter ()
	Set/Get the cente of the reslice cursor.

virtual void	GetCenter (double &, double &, double &)
	Set/Get the cente of the reslice cursor.

virtual void	GetCenter (double[3])
	Set/Get the cente of the reslice cursor.


virtual void	SetThickness (double, double, double)
	Set/Get the thickness of the cursor.

virtual void	SetThickness (double[3])
	Set/Get the thickness of the cursor.

virtual double *	GetThickness ()
	Set/Get the thickness of the cursor.

virtual void	GetThickness (double &, double &, double &)
	Set/Get the thickness of the cursor.

virtual void	GetThickness (double[3])
	Set/Get the thickness of the cursor.


virtual void	SetThickMode (vtkTypeBool)
	Enable disable thick mode.

virtual vtkTypeBool	GetThickMode ()
	Enable disable thick mode.

virtual void	ThickModeOn ()
	Enable disable thick mode.

virtual void	ThickModeOff ()
	Enable disable thick mode.


virtual double *	GetXAxis ()
	Get the computed axes directions.

virtual void	GetXAxis (double &, double &, double &)
	Get the computed axes directions.

virtual void	GetXAxis (double[3])
	Get the computed axes directions.

virtual double *	GetYAxis ()
	Get the computed axes directions.

virtual void	GetYAxis (double &, double &, double &)
	Get the computed axes directions.

virtual void	GetYAxis (double[3])
	Get the computed axes directions.

virtual double *	GetZAxis ()
	Get the computed axes directions.

virtual void	GetZAxis (double &, double &, double &)
	Get the computed axes directions.

virtual void	GetZAxis (double[3])
	Get the computed axes directions.

virtual void	SetXAxis (double, double, double)
	Get the computed axes directions.

virtual void	SetXAxis (double[3])
	Get the computed axes directions.

virtual void	SetYAxis (double, double, double)
	Get the computed axes directions.

virtual void	SetYAxis (double[3])
	Get the computed axes directions.

virtual void	SetZAxis (double, double, double)
	Get the computed axes directions.

virtual void	SetZAxis (double[3])
	Get the computed axes directions.

virtual double *	GetAxis (int i)
	Get the computed axes directions.


virtual void	SetHole (int)
	Show a hole in the center of the cursor, so its easy to see the pixels within the hole.

virtual int	GetHole ()
	Show a hole in the center of the cursor, so its easy to see the pixels within the hole.


virtual void	SetHoleWidth (double)
	Set the width of the hole in mm.

virtual double	GetHoleWidth ()
	Set the width of the hole in mm.


virtual void	SetHoleWidthInPixels (double)
	Set the width of the hole in pixels.

virtual double	GetHoleWidthInPixels ()
	Set the width of the hole in pixels.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkResliceCursor *	SafeDownCast (vtkObjectBase *o)

static vtkResliceCursor *	New ()

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkResliceCursor ()

	~vtkResliceCursor () override

virtual void	BuildCursorGeometry ()

virtual void	BuildPolyData ()

virtual void	BuildCursorTopology ()

virtual void	BuildCursorTopologyWithHole ()

virtual void	BuildCursorTopologyWithoutHole ()

virtual void	BuildCursorGeometryWithoutHole ()

virtual void	BuildCursorGeometryWithHole ()

virtual void	ComputeAxes ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTypeBool	ThickMode

int	Hole

double	HoleWidth

double	HoleWidthInPixels

double	Thickness [3]

double	Center [3]

double	XAxis [3]

double	YAxis [3]

double	ZAxis [3]

double	XViewUp [3]

double	YViewUp [3]

double	ZViewUp [3]

vtkImageData *	Image

vtkPolyData *	PolyData

vtkPolyData *	CenterlineAxis [3]

vtkPlaneCollection *	ReslicePlanes

vtkTimeStamp	PolyDataBuildTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Geometry for a reslice cursor.

This class represents a reslice cursor. It consists of two cross sectional hairs, with an optional thickness. The crosshairs hairs may have a hole in the center. These may be translated or rotated independent of each other in the view. The result is used to reslice the data along these cross sections. This allows the user to perform multi-planar thin or thick reformat of the data on an image view, rather than a 3D view.

See also: vtkResliceCursorWidget vtkResliceCursor vtkResliceCursorPolyDataAlgorithm vtkResliceCursorRepresentation vtkResliceCursorThickLineRepresentation vtkResliceCursorActor vtkImagePlaneWidget

Tests:: vtkResliceCursor (Tests)

Definition at line 35 of file vtkResliceCursor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkResliceCursor::Superclass

Definition at line 38 of file vtkResliceCursor.h.

Constructor & Destructor Documentation

◆ vtkResliceCursor()

vtkResliceCursor::vtkResliceCursor ( )

protected

◆ ~vtkResliceCursor()

vtkResliceCursor::~vtkResliceCursor ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkResliceCursor::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkResliceCursor::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkResliceCursor * vtkResliceCursor::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkResliceCursor::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkResliceCursor * vtkResliceCursor::NewInstance ( ) const

◆ New()

static vtkResliceCursor * vtkResliceCursor::New ( )

static

◆ SetImage()

virtual void vtkResliceCursor::SetImage ( vtkImageData * )

virtual

Set the image (3D) that we are slicing.

◆ GetImage()

virtual vtkImageData * vtkResliceCursor::GetImage ( )

virtual

Set the image (3D) that we are slicing.

◆ SetCenter() [1/2]

virtual void vtkResliceCursor::SetCenter	(	double	,
		double	,
		double
	)

virtual

Set/Get the cente of the reslice cursor.

◆ SetCenter() [2/2]

virtual void vtkResliceCursor::SetCenter ( double center[3] )

virtual

Set/Get the cente of the reslice cursor.

◆ GetCenter() [1/3]

virtual double * vtkResliceCursor::GetCenter ( )

virtual

Set/Get the cente of the reslice cursor.

◆ GetCenter() [2/3]

virtual void vtkResliceCursor::GetCenter	(	double &	,
		double &	,
		double &
	)

virtual

Set/Get the cente of the reslice cursor.

◆ GetCenter() [3/3]

virtual void vtkResliceCursor::GetCenter ( double [3] )

virtual

Set/Get the cente of the reslice cursor.

◆ SetThickness() [1/2]

virtual void vtkResliceCursor::SetThickness	(	double	,
		double	,
		double
	)

virtual

Set/Get the thickness of the cursor.

◆ SetThickness() [2/2]

virtual void vtkResliceCursor::SetThickness ( double [3] )

virtual

Set/Get the thickness of the cursor.

◆ GetThickness() [1/3]

virtual double * vtkResliceCursor::GetThickness ( )

virtual

Set/Get the thickness of the cursor.

◆ GetThickness() [2/3]

virtual void vtkResliceCursor::GetThickness	(	double &	,
		double &	,
		double &
	)

virtual

Set/Get the thickness of the cursor.

◆ GetThickness() [3/3]

virtual void vtkResliceCursor::GetThickness ( double [3] )

virtual

Set/Get the thickness of the cursor.

◆ SetThickMode()

virtual void vtkResliceCursor::SetThickMode ( vtkTypeBool )

virtual

Enable disable thick mode.

Default is to enable it.

◆ GetThickMode()

virtual vtkTypeBool vtkResliceCursor::GetThickMode ( )

virtual

Enable disable thick mode.

Default is to enable it.

◆ ThickModeOn()

virtual void vtkResliceCursor::ThickModeOn ( )

virtual

Enable disable thick mode.

Default is to enable it.

◆ ThickModeOff()

virtual void vtkResliceCursor::ThickModeOff ( )

virtual

Enable disable thick mode.

Default is to enable it.

◆ GetPolyData()

virtual vtkPolyData * vtkResliceCursor::GetPolyData ( )

virtual

Get the 3D PolyData representation.

◆ GetCenterlineAxisPolyData()

virtual vtkPolyData * vtkResliceCursor::GetCenterlineAxisPolyData ( int axis )

virtual

Get the slab and centerline polydata along an axis.

◆ PrintSelf()

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

overridevirtual

Printself method.

Reimplemented from vtkObject.

◆ GetPlane()

virtual vtkPlane * vtkResliceCursor::GetPlane ( int n )

virtual

Get the planes that represent normals along the X, Y and Z.

The argument passed to this method must be an integer in the range 0-2 (corresponding to the X, Y and Z axes.

◆ Update()

virtual void vtkResliceCursor::Update ( )

virtual

Build the polydata.