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

a placer that constrains a handle to a finite plane More...

#include <vtkBoundedPlanePointPlacer.h>

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

Public Types

enum  { XAxis = 0, YAxis, ZAxis, Oblique }
 
typedef vtkPointPlacer Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkPointPlacer
typedef vtkObject Superclass
 Standard methods for instances of this class. More...
 

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...
 
vtkBoundedPlanePointPlacerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetProjectionNormal (int)
 Set the projection normal to lie along the x, y, or z axis, or to be oblique. More...
 
virtual int GetProjectionNormal ()
 
void SetProjectionNormalToXAxis ()
 
void SetProjectionNormalToYAxis ()
 
void SetProjectionNormalToZAxis ()
 
void SetProjectionNormalToOblique ()
 
void SetObliquePlane (vtkPlane *)
 If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position. More...
 
virtual vtkPlaneGetObliquePlane ()
 
void SetProjectionPosition (double position)
 The position of the bounding plane from the origin along the normal. More...
 
virtual double GetProjectionPosition ()
 
void AddBoundingPlane (vtkPlane *plane)
 A collection of plane equations used to bound the position of the point. More...
 
void RemoveBoundingPlane (vtkPlane *plane)
 
void RemoveAllBoundingPlanes ()
 
virtual void SetBoundingPlanes (vtkPlaneCollection *)
 
virtual vtkPlaneCollectionGetBoundingPlanes ()
 
void SetBoundingPlanes (vtkPlanes *planes)
 
int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9]) override
 Given a renderer and a display position, compute the world position and world orientation for this point. More...
 
int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double refWorldPos[3], double worldPos[3], double worldOrient[9]) override
 Given a renderer, a display position, and a reference world position, compute the new world position and orientation of this point. More...
 
int ValidateWorldPosition (double worldPos[3]) override
 Give a world position check if it is valid - does it lie on the plane and within the bounds? Returns 1 if it is valid, 0 otherwise. More...
 
int ValidateWorldPosition (double worldPos[3], double worldOrient[9]) override
 Given a world position and a world orientation, validate it according to the constraints of the placer. More...
 
int UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9]) override
 If the constraints on this placer are changed, then this method will be called by the representation on each of its points. More...
 
- Public Member Functions inherited from vtkPointPlacer
vtkPointPlacerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual int ValidateDisplayPosition (vtkRenderer *, double displayPos[2])
 Given a display position, check the validity of this position. More...
 
virtual int UpdateNodeWorldPosition (double worldPos[3], vtkIdType nodePointId)
 Give the placer a chance to update the node information, if any. More...
 
virtual int UpdateInternalState ()
 Called by the representation to give the placer a chance to update itself. More...
 
virtual void SetPixelTolerance (int)
 Set/get the tolerance used when performing computations in display coordinates. More...
 
virtual int GetPixelTolerance ()
 
virtual void SetWorldTolerance (double)
 Set/get the tolerance used when performing computations in world coordinates. More...
 
virtual double GetWorldTolerance ()
 
- 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...
 
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 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 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkBoundedPlanePointPlacerNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBoundedPlanePointPlacerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPointPlacer
static vtkPointPlacerNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPointPlacerSafeDownCast (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 ()
 
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 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
 
 vtkBoundedPlanePointPlacer ()
 
 ~vtkBoundedPlanePointPlacer () override
 
void GetProjectionNormal (double normal[3])
 
void GetProjectionOrigin (double origin[3])
 
void GetCurrentOrientation (double worldOrient[9])
 
- Protected Member Functions inherited from vtkPointPlacer
 vtkPointPlacer ()
 
 ~vtkPointPlacer () override
 
- 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static double GetDistanceFromObject (double pos[3], vtkPlaneCollection *pc, double closestPt[3])
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

int ProjectionNormal
 
double ProjectionPosition
 
vtkPlaneObliquePlane
 
vtkPlaneCollectionBoundingPlanes
 
- 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
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

a placer that constrains a handle to a finite plane

vtkBoundedPlanePointPlacer is a type of point placer that constrains its points to a finite (i.e., bounded) plance.

See also
vtkPointPlacer vtkHandleWidget vtkHandleRepresentation

Definition at line 37 of file vtkBoundedPlanePointPlacer.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instances of this class.

Definition at line 49 of file vtkBoundedPlanePointPlacer.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
XAxis 
YAxis 
ZAxis 
Oblique 

Definition at line 118 of file vtkBoundedPlanePointPlacer.h.

Constructor & Destructor Documentation

◆ vtkBoundedPlanePointPlacer()

vtkBoundedPlanePointPlacer::vtkBoundedPlanePointPlacer ( )
protected

◆ ~vtkBoundedPlanePointPlacer()

vtkBoundedPlanePointPlacer::~vtkBoundedPlanePointPlacer ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBoundedPlanePointPlacer* vtkBoundedPlanePointPlacer::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBoundedPlanePointPlacer::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPointPlacer.

◆ NewInstance()

vtkBoundedPlanePointPlacer* vtkBoundedPlanePointPlacer::NewInstance ( ) const

◆ PrintSelf()

void vtkBoundedPlanePointPlacer::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.

◆ SetProjectionNormal()

virtual void vtkBoundedPlanePointPlacer::SetProjectionNormal ( int  )
virtual

Set the projection normal to lie along the x, y, or z axis, or to be oblique.

If it is oblique, then the plane is defined in the ObliquePlane ivar.

◆ GetProjectionNormal() [1/2]

virtual int vtkBoundedPlanePointPlacer::GetProjectionNormal ( )
virtual

◆ SetProjectionNormalToXAxis()

void vtkBoundedPlanePointPlacer::SetProjectionNormalToXAxis ( )
inline

Definition at line 62 of file vtkBoundedPlanePointPlacer.h.

◆ SetProjectionNormalToYAxis()

void vtkBoundedPlanePointPlacer::SetProjectionNormalToYAxis ( )
inline

Definition at line 66 of file vtkBoundedPlanePointPlacer.h.

◆ SetProjectionNormalToZAxis()

void vtkBoundedPlanePointPlacer::SetProjectionNormalToZAxis ( )
inline

Definition at line 70 of file vtkBoundedPlanePointPlacer.h.

◆ SetProjectionNormalToOblique()

void vtkBoundedPlanePointPlacer::SetProjectionNormalToOblique ( )
inline

Definition at line 74 of file vtkBoundedPlanePointPlacer.h.

◆ SetObliquePlane()

void vtkBoundedPlanePointPlacer::SetObliquePlane ( vtkPlane )

If the ProjectionNormal is set to Oblique, then this is the oblique plane used to constrain the handle position.

◆ GetObliquePlane()

virtual vtkPlane* vtkBoundedPlanePointPlacer::GetObliquePlane ( )
virtual

◆ SetProjectionPosition()

void vtkBoundedPlanePointPlacer::SetProjectionPosition ( double  position)

The position of the bounding plane from the origin along the normal.

The origin and normal are defined in the oblique plane when the ProjectionNormal is oblique. For the X, Y, and Z axes projection normals, the normal is the axis direction, and the origin is (0,0,0).

◆ GetProjectionPosition()

virtual double vtkBoundedPlanePointPlacer::GetProjectionPosition ( )
virtual

◆ AddBoundingPlane()

void vtkBoundedPlanePointPlacer::AddBoundingPlane ( vtkPlane plane)

A collection of plane equations used to bound the position of the point.

This is in addition to confining the point to a plane - these constraints are meant to, for example, keep a point within the extent of an image. Using a set of plane equations allows for more complex bounds (such as bounding a point to an oblique reliced image that has hexagonal shape) than a simple extent.

◆ RemoveBoundingPlane()

void vtkBoundedPlanePointPlacer::RemoveBoundingPlane ( vtkPlane plane)

◆ RemoveAllBoundingPlanes()

void vtkBoundedPlanePointPlacer::RemoveAllBoundingPlanes ( )

◆ SetBoundingPlanes() [1/2]

virtual void vtkBoundedPlanePointPlacer::SetBoundingPlanes ( vtkPlaneCollection )
virtual

◆ GetBoundingPlanes()

virtual vtkPlaneCollection* vtkBoundedPlanePointPlacer::GetBoundingPlanes ( )
virtual

◆ SetBoundingPlanes() [2/2]

void vtkBoundedPlanePointPlacer::SetBoundingPlanes ( vtkPlanes planes)

◆ ComputeWorldPosition() [1/2]

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

Given a renderer and a display position, compute the world position and world orientation for this point.

A plane is defined by a combination of the ProjectionNormal, ProjectionOrigin, and ObliquePlane ivars. The display position is projected onto this plane to determine a world position, and the orientation is set to the normal of the plane. If the point cannot project onto the plane or if it falls outside the bounds imposed by the BoundingPlanes, then 0 is returned, otherwise 1 is returned to indicate a valid return position and orientation.

Reimplemented from vtkPointPlacer.

◆ ComputeWorldPosition() [2/2]

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

Given a renderer, a display position, and a reference world position, compute the new world position and orientation of this point.

This method is typically used by the representation to move the point.

Reimplemented from vtkPointPlacer.

◆ ValidateWorldPosition() [1/2]

int vtkBoundedPlanePointPlacer::ValidateWorldPosition ( double  worldPos[3])
overridevirtual

Give a world position check if it is valid - does it lie on the plane and within the bounds? Returns 1 if it is valid, 0 otherwise.

Reimplemented from vtkPointPlacer.

◆ ValidateWorldPosition() [2/2]

int vtkBoundedPlanePointPlacer::ValidateWorldPosition ( double  worldPos[3],
double  worldOrient[9] 
)
overridevirtual

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

Reimplemented from vtkPointPlacer.

◆ UpdateWorldPosition()

int vtkBoundedPlanePointPlacer::UpdateWorldPosition ( vtkRenderer ren,
double  worldPos[3],
double  worldOrient[9] 
)
overridevirtual

If the constraints on this placer are changed, then this method will be called by the representation on each of its points.

For this placer, the world position will be converted to a display position, then ComputeWorldPosition will be used to update the point.

Reimplemented from vtkPointPlacer.

◆ GetProjectionNormal() [2/2]

void vtkBoundedPlanePointPlacer::GetProjectionNormal ( double  normal[3])
protected

◆ GetProjectionOrigin()

void vtkBoundedPlanePointPlacer::GetProjectionOrigin ( double  origin[3])
protected

◆ GetCurrentOrientation()

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

◆ GetDistanceFromObject()

static double vtkBoundedPlanePointPlacer::GetDistanceFromObject ( double  pos[3],
vtkPlaneCollection pc,
double  closestPt[3] 
)
staticprotected

Member Data Documentation

◆ ProjectionNormal

int vtkBoundedPlanePointPlacer::ProjectionNormal
protected

Definition at line 182 of file vtkBoundedPlanePointPlacer.h.

◆ ProjectionPosition

double vtkBoundedPlanePointPlacer::ProjectionPosition
protected

Definition at line 186 of file vtkBoundedPlanePointPlacer.h.

◆ ObliquePlane

vtkPlane* vtkBoundedPlanePointPlacer::ObliquePlane
protected

Definition at line 190 of file vtkBoundedPlanePointPlacer.h.

◆ BoundingPlanes

vtkPlaneCollection* vtkBoundedPlanePointPlacer::BoundingPlanes
protected

Definition at line 194 of file vtkBoundedPlanePointPlacer.h.


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