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

#include <vtkFocalPlanePointPlacer.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkFocalPlanePointPlacerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9])
 
int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[3], double worldPos[3], double worldOrient[9])
 
int ValidateWorldPosition (double worldPos[3])
 
int ValidateWorldPosition (double worldPos[3], double worldOrient[9])
 
virtual void SetOffset (double)
 
virtual double GetOffset ()
 
virtual void SetPointBounds (double, double, double, double, double, double)
 
virtual void SetPointBounds (double[6])
 
virtual doubleGetPointBounds ()
 
virtual void GetPointBounds (double &, double &, double &, double &, double &, double &)
 
virtual void GetPointBounds (double[6])
 
- Public Member Functions inherited from vtkPointPlacer
vtkPointPlacerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ValidateDisplayPosition (vtkRenderer *, double displayPos[2])
 
virtual int UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9])
 
virtual int UpdateNodeWorldPosition (double worldPos[3], vtkIdType nodePointId)
 
virtual int UpdateInternalState ()
 
virtual void SetPixelTolerance (int)
 
virtual int GetPixelTolerance ()
 
virtual void SetWorldTolerance (double)
 
virtual double GetWorldTolerance ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool 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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkFocalPlanePointPlacerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkFocalPlanePointPlacerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPointPlacer
static vtkPointPlacerNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPointPlacerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkFocalPlanePointPlacer ()
 
 ~vtkFocalPlanePointPlacer ()
 
void GetCurrentOrientation (double worldOrient[9])
 
- 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 &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double PointBounds [6]
 
double Offset
 
- Protected Attributes inherited from vtkPointPlacer
int PixelTolerance
 
double WorldTolerance
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Definition at line 28 of file vtkFocalPlanePointPlacer.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 36 of file vtkFocalPlanePointPlacer.h.

Constructor & Destructor Documentation

◆ vtkFocalPlanePointPlacer()

vtkFocalPlanePointPlacer::vtkFocalPlanePointPlacer ( )
protected

◆ ~vtkFocalPlanePointPlacer()

vtkFocalPlanePointPlacer::~vtkFocalPlanePointPlacer ( )
protected

Member Function Documentation

◆ New()

static vtkFocalPlanePointPlacer* vtkFocalPlanePointPlacer::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkFocalPlanePointPlacer::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 vtkPointPlacer.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFocalPlanePointPlacer::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPointPlacer.

◆ NewInstance()

vtkFocalPlanePointPlacer* vtkFocalPlanePointPlacer::NewInstance ( ) const

◆ PrintSelf()

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

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.

◆ ComputeWorldPosition() [1/2]

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

Given a renderer and a display position in pixel coordinates, compute the world position and orientation where this point will be placed. This method is typically used by the representation to place the point initially. A return value of 1 indicates that constraints of the placer are met.

Reimplemented from vtkPointPlacer.

◆ ComputeWorldPosition() [2/2]

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

Given a renderer, a display position, and a reference world position, compute a new world position. The orientation will be the standard coordinate axes, and the computed world position will be created by projecting the display point onto a plane that is parallel to the focal plane and runs through the reference world position. This method is typically used to move existing points.

Reimplemented from vtkPointPlacer.

◆ ValidateWorldPosition() [1/2]

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

Validate a world position. All world positions are valid so these methods always return 1.

Reimplemented from vtkPointPlacer.

◆ ValidateWorldPosition() [2/2]

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

Given a world position and a world orientation, validate it according to the constraints of the placer.

Reimplemented from vtkPointPlacer.

◆ SetOffset()

virtual void vtkFocalPlanePointPlacer::SetOffset ( double  )
virtual

Optionally specify a signed offset from the focal plane for the points to be placed at. If negative, the constraint plane is offset closer to the camera. If positive, its further away from the camera.

◆ GetOffset()

virtual double vtkFocalPlanePointPlacer::GetOffset ( )
virtual

◆ SetPointBounds() [1/2]

virtual void vtkFocalPlanePointPlacer::SetPointBounds ( double  ,
double  ,
double  ,
double  ,
double  ,
double   
)
virtual

Optionally Restrict the points to a set of bounds. The placer will invalidate points outside these bounds.

◆ SetPointBounds() [2/2]

virtual void vtkFocalPlanePointPlacer::SetPointBounds ( double  [6])
virtual

◆ GetPointBounds() [1/3]

virtual double* vtkFocalPlanePointPlacer::GetPointBounds ( )
virtual

◆ GetPointBounds() [2/3]

virtual void vtkFocalPlanePointPlacer::GetPointBounds ( double ,
double ,
double ,
double ,
double ,
double  
)
virtual

◆ GetPointBounds() [3/3]

virtual void vtkFocalPlanePointPlacer::GetPointBounds ( double  [6])
virtual

◆ GetCurrentOrientation()

void vtkFocalPlanePointPlacer::GetCurrentOrientation ( double  worldOrient[9])
protected

Member Data Documentation

◆ PointBounds

double vtkFocalPlanePointPlacer::PointBounds[6]
protected

Definition at line 96 of file vtkFocalPlanePointPlacer.h.

◆ Offset

double vtkFocalPlanePointPlacer::Offset
protected

Definition at line 97 of file vtkFocalPlanePointPlacer.h.


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