VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkResliceCursor Class Reference

Geometry for a reslice cursor. More...

#include <vtkResliceCursor.h>

Inheritance diagram for vtkResliceCursor:
[legend]
Collaboration diagram for vtkResliceCursor:
[legend]

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. More...
 
vtkResliceCursorNewInstance () const
 
virtual void SetImage (vtkImageData *)
 Set the image (3D) that we are slicing. More...
 
virtual vtkImageDataGetImage ()
 
virtual void SetCenter (double, double, double)
 Set/Get the cente of the reslice cursor. More...
 
virtual void SetCenter (double center[3])
 
virtual double * GetCenter ()
 
virtual void GetCenter (double &, double &, double &)
 
virtual void GetCenter (double[3])
 
virtual void SetThickness (double, double, double)
 Set/Get the thickness of the cursor. More...
 
virtual void SetThickness (double[3])
 
virtual double * GetThickness ()
 
virtual void GetThickness (double &, double &, double &)
 
virtual void GetThickness (double[3])
 
virtual void SetThickMode (vtkTypeBool)
 Enable disable thick mode. More...
 
virtual vtkTypeBool GetThickMode ()
 
virtual void ThickModeOn ()
 
virtual void ThickModeOff ()
 
virtual vtkPolyDataGetPolyData ()
 Get the 3D PolyData representation. More...
 
virtual vtkPolyDataGetCenterlineAxisPolyData (int axis)
 Get the slab and centerline polydata along an axis. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Printself method. More...
 
virtual vtkPlaneGetPlane (int n)
 Get the planes that represent normals along the X, Y and Z. More...
 
virtual void Update ()
 Build the polydata. More...
 
virtual double * GetXAxis ()
 Get the computed axes directions. More...
 
virtual void GetXAxis (double &, double &, double &)
 
virtual void GetXAxis (double[3])
 
virtual double * GetYAxis ()
 
virtual void GetYAxis (double &, double &, double &)
 
virtual void GetYAxis (double[3])
 
virtual double * GetZAxis ()
 
virtual void GetZAxis (double &, double &, double &)
 
virtual void GetZAxis (double[3])
 
virtual void SetXAxis (double, double, double)
 
virtual void SetXAxis (double[3])
 
virtual void SetYAxis (double, double, double)
 
virtual void SetYAxis (double[3])
 
virtual void SetZAxis (double, double, double)
 
virtual void SetZAxis (double[3])
 
virtual double * GetAxis (int i)
 
virtual void SetHole (int)
 Show a hole in the center of the cursor, so its easy to see the pixels within the hole. More...
 
virtual int GetHole ()
 
virtual void SetHoleWidth (double)
 Set the width of the hole in mm. More...
 
virtual double GetHoleWidth ()
 
virtual void SetHoleWidthInPixels (double)
 Set the width of the hole in pixels. More...
 
virtual double GetHoleWidthInPixels ()
 
vtkMTimeType GetMTime () override
 Get the MTime. More...
 
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. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkResliceCursorSafeDownCast (vtkObjectBase *o)
 
static vtkResliceCursorNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 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]
 
vtkImageDataImage
 
vtkPolyDataPolyData
 
vtkPolyDataCenterlineAxis [3]
 
vtkPlaneCollectionReslicePlanes
 
vtkTimeStamp PolyDataBuildTime
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Definition at line 43 of file vtkResliceCursor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 46 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

◆ 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

◆ GetCenter() [1/3]

virtual double* vtkResliceCursor::GetCenter ( )
virtual

◆ GetCenter() [2/3]

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

◆ GetCenter() [3/3]

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

◆ 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

◆ GetThickness() [1/3]

virtual double* vtkResliceCursor::GetThickness ( )
virtual

◆ GetThickness() [2/3]

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

◆ GetThickness() [3/3]

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

◆ SetThickMode()

virtual void vtkResliceCursor::SetThickMode ( vtkTypeBool  )
virtual

Enable disable thick mode.

Default is to enable it.

◆ GetThickMode()

virtual vtkTypeBool vtkResliceCursor::GetThickMode ( )
virtual

◆ ThickModeOn()

virtual void vtkResliceCursor::ThickModeOn ( )
virtual

◆ ThickModeOff()

virtual void vtkResliceCursor::ThickModeOff ( )
virtual

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

◆ GetXAxis() [1/3]

virtual double* vtkResliceCursor::GetXAxis ( )
virtual

Get the computed axes directions.

◆ GetXAxis() [2/3]

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

◆ GetXAxis() [3/3]

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

◆ GetYAxis() [1/3]

virtual double* vtkResliceCursor::GetYAxis ( )
virtual

◆ GetYAxis() [2/3]

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

◆ GetYAxis() [3/3]

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

◆ GetZAxis() [1/3]

virtual double* vtkResliceCursor::GetZAxis ( )
virtual

◆ GetZAxis() [2/3]

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

◆ GetZAxis() [3/3]

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

◆ SetXAxis() [1/2]

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

◆ SetXAxis() [2/2]

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

◆ SetYAxis() [1/2]

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

◆ SetYAxis() [2/2]

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

◆ SetZAxis() [1/2]

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

◆ SetZAxis() [2/2]

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

◆ GetAxis()

virtual double* vtkResliceCursor::GetAxis ( int  i)
virtual

◆ SetHole()

virtual void vtkResliceCursor::SetHole ( int  )
virtual

Show a hole in the center of the cursor, so its easy to see the pixels within the hole.

ON by default

◆ GetHole()

virtual int vtkResliceCursor::GetHole ( )
virtual

◆ SetHoleWidth()

virtual void vtkResliceCursor::SetHoleWidth ( double  )
virtual

Set the width of the hole in mm.

◆ GetHoleWidth()

virtual double vtkResliceCursor::GetHoleWidth ( )
virtual

◆ SetHoleWidthInPixels()

virtual void vtkResliceCursor::SetHoleWidthInPixels ( double  )
virtual

Set the width of the hole in pixels.

If set, this will override the hole with in mm.

◆ GetHoleWidthInPixels()

virtual double vtkResliceCursor::GetHoleWidthInPixels ( )
virtual

◆ GetMTime()

vtkMTimeType vtkResliceCursor::GetMTime ( )
overridevirtual

Get the MTime.

Check the MTime of the internal planes as well.

Reimplemented from vtkObject.

◆ Reset()

virtual void vtkResliceCursor::Reset ( )
virtual

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.

◆ BuildCursorGeometry()

virtual void vtkResliceCursor::BuildCursorGeometry ( )
protectedvirtual

◆ BuildPolyData()

virtual void vtkResliceCursor::BuildPolyData ( )
protectedvirtual

◆ BuildCursorTopology()

virtual void vtkResliceCursor::BuildCursorTopology ( )
protectedvirtual

◆ BuildCursorTopologyWithHole()

virtual void vtkResliceCursor::BuildCursorTopologyWithHole ( )
protectedvirtual

◆ BuildCursorTopologyWithoutHole()

virtual void vtkResliceCursor::BuildCursorTopologyWithoutHole ( )
protectedvirtual

◆ BuildCursorGeometryWithoutHole()

virtual void vtkResliceCursor::BuildCursorGeometryWithoutHole ( )
protectedvirtual

◆ BuildCursorGeometryWithHole()

virtual void vtkResliceCursor::BuildCursorGeometryWithHole ( )
protectedvirtual

◆ ComputeAxes()

virtual void vtkResliceCursor::ComputeAxes ( )
protectedvirtual

Member Data Documentation

◆ ThickMode

vtkTypeBool vtkResliceCursor::ThickMode
protected

Definition at line 175 of file vtkResliceCursor.h.

◆ Hole

int vtkResliceCursor::Hole
protected

Definition at line 176 of file vtkResliceCursor.h.

◆ HoleWidth

double vtkResliceCursor::HoleWidth
protected

Definition at line 177 of file vtkResliceCursor.h.

◆ HoleWidthInPixels

double vtkResliceCursor::HoleWidthInPixels
protected

Definition at line 178 of file vtkResliceCursor.h.

◆ Thickness

double vtkResliceCursor::Thickness[3]
protected

Definition at line 179 of file vtkResliceCursor.h.

◆ Center

double vtkResliceCursor::Center[3]
protected

Definition at line 180 of file vtkResliceCursor.h.

◆ XAxis

double vtkResliceCursor::XAxis[3]
protected

Definition at line 181 of file vtkResliceCursor.h.

◆ YAxis

double vtkResliceCursor::YAxis[3]
protected

Definition at line 182 of file vtkResliceCursor.h.

◆ ZAxis

double vtkResliceCursor::ZAxis[3]
protected

Definition at line 183 of file vtkResliceCursor.h.

◆ Image

vtkImageData* vtkResliceCursor::Image
protected

Definition at line 184 of file vtkResliceCursor.h.

◆ PolyData

vtkPolyData* vtkResliceCursor::PolyData
protected

Definition at line 185 of file vtkResliceCursor.h.

◆ CenterlineAxis

vtkPolyData* vtkResliceCursor::CenterlineAxis[3]
protected

Definition at line 187 of file vtkResliceCursor.h.

◆ ReslicePlanes

vtkPlaneCollection* vtkResliceCursor::ReslicePlanes
protected

Definition at line 189 of file vtkResliceCursor.h.

◆ PolyDataBuildTime

vtkTimeStamp vtkResliceCursor::PolyDataBuildTime
protected

Definition at line 190 of file vtkResliceCursor.h.


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