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

Converts 2D display positions to world positions such that they lie on an ImageActor. More...

#include <vtkImageActorPointPlacer.h>

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

Public Member Functions

int ValidateWorldPosition (double worldPos[3])
int UpdateInternalState ()
virtual void SetWorldTolerance (double s)
int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9])
int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[2], double worldPos[3], double worldOrient[9])
int ValidateWorldPosition (double worldPos[3], double worldOrient[9])
int UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9])
void SetImageActor (vtkImageActor *)
virtual vtkImageActorGetImageActor ()
virtual void SetBounds (double, double, double, double, double, double)
virtual void SetBounds (double[6])
virtual double * GetBounds ()
virtual void GetBounds (double &, double &, double &, double &, double &, double &)
virtual void GetBounds (double[6])
- Public Member Functions inherited from vtkPointPlacer
virtual int ValidateDisplayPosition (vtkRenderer *, double displayPos[2])
virtual int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[3], double worldPos[3], double worldOrient[9])
virtual void SetPixelTolerance (int)
virtual int GetPixelTolerance ()
virtual double GetWorldTolerance ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
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 *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
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
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkImageActorPointPlacerNew ()
- Static Public Member Functions inherited from vtkPointPlacer

Protected Member Functions

 vtkImageActorPointPlacer ()
 ~vtkImageActorPointPlacer ()
- Protected Member Functions inherited from vtkPointPlacer
 vtkPointPlacer ()
 ~vtkPointPlacer ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkImageActorImageActor
vtkBoundedPlanePointPlacerPlacer
double SavedBounds [6]
double Bounds [6]
- Protected Attributes inherited from vtkPointPlacer
int PixelTolerance
double WorldTolerance
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
typedef vtkPointPlacer Superclass
static int IsTypeOf (const char *type)
static vtkImageActorPointPlacerSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Additional Inherited Members

- Public Types inherited from vtkPointPlacer
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
- Friends inherited from vtkObject

Detailed Description

Converts 2D display positions to world positions such that they lie on an ImageActor.

This PointPlacer is used to constrain the placement of points on the supplied image actor. Additionally, you may set bounds to restrict the placement of the points. The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

Tests:
vtkImageActorPointPlacer (Tests)

Definition at line 37 of file vtkImageActorPointPlacer.h.

Member Typedef Documentation

Standard methods for instances of this class.

Definition at line 45 of file vtkImageActorPointPlacer.h.

Constructor & Destructor Documentation

vtkImageActorPointPlacer::vtkImageActorPointPlacer ( )
protected
vtkImageActorPointPlacer::~vtkImageActorPointPlacer ( )
protected

Member Function Documentation

static vtkImageActorPointPlacer* vtkImageActorPointPlacer::New ( )
static

Instantiate this class.

Reimplemented from vtkPointPlacer.

virtual const char* vtkImageActorPointPlacer::GetClassName ( )
virtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

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

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

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

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

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

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

void vtkImageActorPointPlacer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Standard methods for instances of this class.

Reimplemented from vtkPointPlacer.

int vtkImageActorPointPlacer::ComputeWorldPosition ( vtkRenderer ren,
double  displayPos[2],
double  worldPos[3],
double  worldOrient[9] 
)
virtual

Given and renderer and a display position in pixels, find a world position and orientation. In this class an internal vtkBoundedPlanePointPlacer is used to compute the world position and orientation. The internal placer is set to use the plane of the image actor and the bounds of the image actor as the constraints for placing points.

Reimplemented from vtkPointPlacer.

int vtkImageActorPointPlacer::ComputeWorldPosition ( vtkRenderer ren,
double  displayPos[2],
double  refWorldPos[2],
double  worldPos[3],
double  worldOrient[9] 
)

This method is identical to the one above since the reference position is ignored by the bounded plane point placer.

int vtkImageActorPointPlacer::ValidateWorldPosition ( double  worldPos[3])
virtual

This method validates a world position by checking to see if the world position is valid according to the constraints of the internal placer (essentially - is this world position on the image?)

Reimplemented from vtkPointPlacer.

int vtkImageActorPointPlacer::ValidateWorldPosition ( double  worldPos[3],
double  worldOrient[9] 
)
virtual

This method is identical to the one above since the bounded plane point placer ignores orientation

Reimplemented from vtkPointPlacer.

int vtkImageActorPointPlacer::UpdateWorldPosition ( vtkRenderer ren,
double  worldPos[3],
double  worldOrient[9] 
)
virtual

Update the world position and orientation according the the current constraints of the placer. Will be called by the representation when it notices that this placer has been modified.

Reimplemented from vtkPointPlacer.

int vtkImageActorPointPlacer::UpdateInternalState ( )
virtual

A method for configuring the internal placer according to the constraints of the image actor. Called by the representation to give the placer a chance to update itself, which may cause the MTime to change, which would then cause the representation to update all of its points

Reimplemented from vtkPointPlacer.

void vtkImageActorPointPlacer::SetImageActor ( vtkImageActor )

Set / get the reference vtkImageActor used to place the points. An image actor must be set for this placer to work. An internal bounded plane point placer is created and set to match the bounds of the displayed image.

virtual vtkImageActor* vtkImageActorPointPlacer::GetImageActor ( )
virtual

Set / get the reference vtkImageActor used to place the points. An image actor must be set for this placer to work. An internal bounded plane point placer is created and set to match the bounds of the displayed image.

virtual void vtkImageActorPointPlacer::SetBounds ( double  ,
double  ,
double  ,
double  ,
double  ,
double   
)
virtual

Optionally, you may set bounds to restrict the placement of the points. The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

virtual void vtkImageActorPointPlacer::SetBounds ( double  [6])
virtual

Optionally, you may set bounds to restrict the placement of the points. The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

virtual double* vtkImageActorPointPlacer::GetBounds ( )
virtual

Optionally, you may set bounds to restrict the placement of the points. The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

virtual void vtkImageActorPointPlacer::GetBounds ( double &  ,
double &  ,
double &  ,
double &  ,
double &  ,
double &   
)
virtual

Optionally, you may set bounds to restrict the placement of the points. The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

virtual void vtkImageActorPointPlacer::GetBounds ( double  [6])
virtual

Optionally, you may set bounds to restrict the placement of the points. The placement of points will then be constrained to lie not only on the ImageActor but also within the bounds specified. If no bounds are specified, they may lie anywhere on the supplied ImageActor.

virtual void vtkImageActorPointPlacer::SetWorldTolerance ( double  s)
virtual

Set the world tolerance. This propagates it to the internal BoundedPlanePointPlacer.

Reimplemented from vtkPointPlacer.

Member Data Documentation

vtkImageActor* vtkImageActorPointPlacer::ImageActor
protected

Definition at line 131 of file vtkImageActorPointPlacer.h.

vtkBoundedPlanePointPlacer* vtkImageActorPointPlacer::Placer
protected

Definition at line 134 of file vtkImageActorPointPlacer.h.

double vtkImageActorPointPlacer::SavedBounds[6]
protected

Definition at line 138 of file vtkImageActorPointPlacer.h.

double vtkImageActorPointPlacer::Bounds[6]
protected

Definition at line 141 of file vtkImageActorPointPlacer.h.


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