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

Connect three vtkImagePlaneWidgets together. More...

#include <vtkImageOrthoPlanes.h>

Inheritance diagram for vtkImageOrthoPlanes:
[legend]
Collaboration diagram for vtkImageOrthoPlanes:
[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...
 
vtkImageOrthoPlanesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void ResetPlanes ()
 Reset the planes to original scale, rotation, and location. More...
 
vtkTransformGetTransform ()
 Get the transform for the planes. More...
 
void HandlePlaneEvent (vtkImagePlaneWidget *imagePlaneWidget)
 A public method to be used only by the event callback. More...
 
void SetPlane (int i, vtkImagePlaneWidget *imagePlaneWidget)
 You must set three planes for the widget. More...
 
vtkImagePlaneWidgetGetPlane (int i)
 You must set three planes for the widget. 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...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
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). 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkImageOrthoPlanesNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageOrthoPlanesSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageOrthoPlanes ()
 
 ~vtkImageOrthoPlanes () override
 
void HandlePlaneRotation (vtkImagePlaneWidget *imagePlaneWidget, int indexOfModifiedPlane)
 
void HandlePlanePush (vtkImagePlaneWidget *imagePlaneWidget, int indexOfModifiedPlane)
 
void HandlePlaneTranslate (vtkImagePlaneWidget *imagePlaneWidget, int indexOfModifiedPlane)
 
void HandlePlaneScale (vtkImagePlaneWidget *imagePlaneWidget, int indexOfModifiedPlane)
 
void SetTransformMatrix (vtkMatrix4x4 *matrix, vtkImagePlaneWidget *currentImagePlane, int indexOfModifiedPlane)
 
void GetBounds (double bounds[3])
 
- 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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 *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Origin [3][3]
 
double Point1 [3][3]
 
double Point2 [3][3]
 
vtkTransformTransform
 
vtkImagePlaneWidget ** Planes
 
int NumberOfPlanes
 
long * ObserverTags
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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

Connect three vtkImagePlaneWidgets together.

vtkImageOrthoPlanes is an event observer class that listens to the events from three vtkImagePlaneWidgets and keeps their orientations and scales synchronized.

See also
vtkImagePlaneWidget
Thanks:
Thanks to Atamai Inc. for developing and contributing this class.

Definition at line 38 of file vtkImageOrthoPlanes.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file vtkImageOrthoPlanes.h.

Constructor & Destructor Documentation

◆ vtkImageOrthoPlanes()

vtkImageOrthoPlanes::vtkImageOrthoPlanes ( )
protected

◆ ~vtkImageOrthoPlanes()

vtkImageOrthoPlanes::~vtkImageOrthoPlanes ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImageOrthoPlanes * vtkImageOrthoPlanes::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkImageOrthoPlanes::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 vtkImageOrthoPlanes * vtkImageOrthoPlanes::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImageOrthoPlanes::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkImageOrthoPlanes * vtkImageOrthoPlanes::NewInstance ( ) const

◆ PrintSelf()

void vtkImageOrthoPlanes::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetPlane()

void vtkImageOrthoPlanes::SetPlane ( int  i,
vtkImagePlaneWidget imagePlaneWidget 
)

You must set three planes for the widget.

◆ GetPlane()

vtkImagePlaneWidget * vtkImageOrthoPlanes::GetPlane ( int  i)

You must set three planes for the widget.

◆ ResetPlanes()

void vtkImageOrthoPlanes::ResetPlanes ( )

Reset the planes to original scale, rotation, and location.

◆ GetTransform()

vtkTransform * vtkImageOrthoPlanes::GetTransform ( )
inline

Get the transform for the planes.

Definition at line 61 of file vtkImageOrthoPlanes.h.

◆ HandlePlaneEvent()

void vtkImageOrthoPlanes::HandlePlaneEvent ( vtkImagePlaneWidget imagePlaneWidget)

A public method to be used only by the event callback.

◆ HandlePlaneRotation()

void vtkImageOrthoPlanes::HandlePlaneRotation ( vtkImagePlaneWidget imagePlaneWidget,
int  indexOfModifiedPlane 
)
protected

◆ HandlePlanePush()

void vtkImageOrthoPlanes::HandlePlanePush ( vtkImagePlaneWidget imagePlaneWidget,
int  indexOfModifiedPlane 
)
protected

◆ HandlePlaneTranslate()

void vtkImageOrthoPlanes::HandlePlaneTranslate ( vtkImagePlaneWidget imagePlaneWidget,
int  indexOfModifiedPlane 
)
protected

◆ HandlePlaneScale()

void vtkImageOrthoPlanes::HandlePlaneScale ( vtkImagePlaneWidget imagePlaneWidget,
int  indexOfModifiedPlane 
)
protected

◆ SetTransformMatrix()

void vtkImageOrthoPlanes::SetTransformMatrix ( vtkMatrix4x4 matrix,
vtkImagePlaneWidget currentImagePlane,
int  indexOfModifiedPlane 
)
protected

◆ GetBounds()

void vtkImageOrthoPlanes::GetBounds ( double  bounds[3])
protected

Member Data Documentation

◆ Origin

double vtkImageOrthoPlanes::Origin[3][3]
protected

Definition at line 83 of file vtkImageOrthoPlanes.h.

◆ Point1

double vtkImageOrthoPlanes::Point1[3][3]
protected

Definition at line 84 of file vtkImageOrthoPlanes.h.

◆ Point2

double vtkImageOrthoPlanes::Point2[3][3]
protected

Definition at line 85 of file vtkImageOrthoPlanes.h.

◆ Transform

vtkTransform* vtkImageOrthoPlanes::Transform
protected

Definition at line 89 of file vtkImageOrthoPlanes.h.

◆ Planes

vtkImagePlaneWidget** vtkImageOrthoPlanes::Planes
protected

Definition at line 92 of file vtkImageOrthoPlanes.h.

◆ NumberOfPlanes

int vtkImageOrthoPlanes::NumberOfPlanes
protected

Definition at line 95 of file vtkImageOrthoPlanes.h.

◆ ObserverTags

long* vtkImageOrthoPlanes::ObserverTags
protected

Definition at line 98 of file vtkImageOrthoPlanes.h.


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