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

Place points on the surface of polygonal data. More...

#include <vtkPolygonalSurfacePointPlacer.h>

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

Public Member Functions

void AddProp (vtkProp *) override
 
void RemoveViewProp (vtkProp *prop) override
 
void RemoveAllProps () override
 
int ComputeWorldPosition (vtkRenderer *ren, double displayPos[2], double worldPos[3], double worldOrient[9]) override
 Given a renderer and a display position in pixel coordinates, compute the world position and orientation where this point will be placed. 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
 Given a world position check the validity of this position according to the constraints of the placer. More...
 
int UpdateNodeWorldPosition (double worldPos[3], vtkIdType nodePointId) override
 Give the node a chance to update its auxiliary point id. More...
 
int ValidateDisplayPosition (vtkRenderer *, double displayPos[2]) override
 Given a display position, check the validity of this position. 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...
 
virtual vtkCellPickerGetCellPicker ()
 Get the Prop picker. More...
 
virtual vtkPolyDataCollectionGetPolys ()
 Be sure to add polydata on which you wish to place points to this list or they will not be considered for placement. More...
 
virtual void SetDistanceOffset (double)
 Height offset at which points may be placed on the polygonal surface. More...
 
virtual double GetDistanceOffset ()
 Height offset at which points may be placed on the polygonal surface. More...
 
virtual void SetSnapToClosestPoint (int)
 Snap to the closest point on the surface ? This is useful for the vtkPolygonalSurfaceContourLineInterpolator, when drawing contours along the edges of a surface mesh. More...
 
virtual int GetSnapToClosestPoint ()
 Snap to the closest point on the surface ? This is useful for the vtkPolygonalSurfaceContourLineInterpolator, when drawing contours along the edges of a surface mesh. More...
 
virtual void SnapToClosestPointOn ()
 Snap to the closest point on the surface ? This is useful for the vtkPolygonalSurfaceContourLineInterpolator, when drawing contours along the edges of a surface mesh. More...
 
virtual void SnapToClosestPointOff ()
 Snap to the closest point on the surface ? This is useful for the vtkPolygonalSurfaceContourLineInterpolator, when drawing contours along the edges of a surface mesh. More...
 
- Public Member Functions inherited from vtkPolyDataPointPlacer
int HasProp (vtkProp *)
 
int GetNumberOfProps ()
 
virtual vtkPropPickerGetPropPicker ()
 Get the Prop picker. More...
 
vtkPolyDataPointPlacerNewInstance () const
 Standard methods for instances of this class. More...
 
- Public Member Functions inherited from vtkPointPlacer
virtual int UpdateWorldPosition (vtkRenderer *ren, double worldPos[3], double worldOrient[9])
 Given a current renderer, world position and orientation, update them according to the constraints of the placer. 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 ()
 Set/get the tolerance used when performing computations in display coordinates. More...
 
virtual void SetWorldTolerance (double)
 Set/get the tolerance used when performing computations in world coordinates. More...
 
virtual double GetWorldTolerance ()
 Set/get the tolerance used when performing computations in world coordinates. More...
 
vtkPointPlacerNewInstance () const
 Standard methods for instances of this class. 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 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)
 
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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 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...
 
void PrintRevisions (ostream &)
 Legacy. 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 vtkPolygonalSurfacePointPlacerNew ()
 Instantiate this class. More...
 
- Static Public Member Functions inherited from vtkPolyDataPointPlacer
static vtkPolyDataPointPlacerNew ()
 Instantiate this class. More...
 
static int IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkPolyDataPointPlacerSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
- Static Public Member Functions inherited from vtkPointPlacer
static vtkPointPlacerNew ()
 Instantiate this class. More...
 
static int IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkPointPlacerSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

 vtkPolygonalSurfacePointPlacer ()
 
 ~vtkPolygonalSurfacePointPlacer () override
 
- Protected Member Functions inherited from vtkPolyDataPointPlacer
 vtkPolyDataPointPlacer ()
 
 ~vtkPolyDataPointPlacer () override
 
- 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=NULL)
 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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkCellPickerCellPicker
 
vtkPolyDataCollectionPolys
 
vtkPolygonalSurfacePointPlacerInternals * Internals
 
double DistanceOffset
 
int SnapToClosestPoint
 
- Protected Attributes inherited from vtkPolyDataPointPlacer
vtkPropCollectionSurfaceProps
 
vtkPropPickerPropPicker
 
- 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
 
typedef vtkPolyDataPointPlacer Superclass
 Standard methods for instances of this class. More...
 
static int IsTypeOf (const char *type)
 Standard methods for instances of this class. More...
 
static vtkPolygonalSurfacePointPlacerSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
virtual int IsA (const char *type)
 Standard methods for instances of this class. More...
 
vtkPolygonalSurfacePointPlacerNewInstance () const
 Standard methods for instances of this class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instances of this class. More...
 
typedef vtkPolygonalSurfacePointPlacerNode Node
 Internally used by the interpolator. More...
 
NodeGetNodeAtWorldPosition (double worldPos[3])
 Internally used by the interpolator. More...
 

Additional Inherited Members

- Public Types inherited from vtkPolyDataPointPlacer
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...
 

Detailed Description

Place points on the surface of polygonal data.

vtkPolygonalSurfacePointPlacer places points on polygonal data and is meant to be used in conjunction with vtkPolygonalSurfaceContourLineInterpolator.

Warning
You should have computed cell normals for the input polydata if you are specifying a distance offset.
See also
vtkPointPlacer vtkPolyDataNormals
Tests:
vtkPolygonalSurfacePointPlacer (Tests)

Definition at line 59 of file vtkPolygonalSurfacePointPlacer.h.

Member Typedef Documentation

Standard methods for instances of this class.

Definition at line 72 of file vtkPolygonalSurfacePointPlacer.h.

Internally used by the interpolator.

Definition at line 165 of file vtkPolygonalSurfacePointPlacer.h.

Constructor & Destructor Documentation

vtkPolygonalSurfacePointPlacer::vtkPolygonalSurfacePointPlacer ( )
protected
vtkPolygonalSurfacePointPlacer::~vtkPolygonalSurfacePointPlacer ( )
overrideprotected

Member Function Documentation

static vtkPolygonalSurfacePointPlacer* vtkPolygonalSurfacePointPlacer::New ( )
static

Instantiate this class.

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

Standard methods for instances of this class.

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

Standard methods for instances of this class.

Reimplemented from vtkPolyDataPointPlacer.

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

Standard methods for instances of this class.

virtual vtkObjectBase* vtkPolygonalSurfacePointPlacer::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkPolyDataPointPlacer.

vtkPolygonalSurfacePointPlacer* vtkPolygonalSurfacePointPlacer::NewInstance ( ) const

Standard methods for instances of this class.

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

Standard methods for instances of this class.

Reimplemented from vtkPolyDataPointPlacer.

void vtkPolygonalSurfacePointPlacer::AddProp ( vtkProp )
overridevirtual

Reimplemented from vtkPolyDataPointPlacer.

void vtkPolygonalSurfacePointPlacer::RemoveViewProp ( vtkProp prop)
overridevirtual

Reimplemented from vtkPolyDataPointPlacer.

void vtkPolygonalSurfacePointPlacer::RemoveAllProps ( )
overridevirtual

Reimplemented from vtkPolyDataPointPlacer.

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

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. For the Terrain point placer this computes world points that lie at the specified height above the terrain.

Reimplemented from vtkPolyDataPointPlacer.

int vtkPolygonalSurfacePointPlacer::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 vtkPolyDataPointPlacer.

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

Given a world position check the validity of this position according to the constraints of the placer.

Reimplemented from vtkPolyDataPointPlacer.

int vtkPolygonalSurfacePointPlacer::UpdateNodeWorldPosition ( double  worldPos[3],
vtkIdType  nodePointId 
)
overridevirtual

Give the node a chance to update its auxiliary point id.

Reimplemented from vtkPointPlacer.

int vtkPolygonalSurfacePointPlacer::ValidateDisplayPosition ( vtkRenderer ,
double  displayPos[2] 
)
overridevirtual

Given a display position, check the validity of this position.

Reimplemented from vtkPolyDataPointPlacer.

int vtkPolygonalSurfacePointPlacer::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 vtkPolyDataPointPlacer.

virtual vtkCellPicker* vtkPolygonalSurfacePointPlacer::GetCellPicker ( )
virtual

Get the Prop picker.

virtual vtkPolyDataCollection* vtkPolygonalSurfacePointPlacer::GetPolys ( )
virtual

Be sure to add polydata on which you wish to place points to this list or they will not be considered for placement.

virtual void vtkPolygonalSurfacePointPlacer::SetDistanceOffset ( double  )
virtual

Height offset at which points may be placed on the polygonal surface.

If you specify a non-zero value here, be sure to compute cell normals on your input polygonal data (easily done with vtkPolyDataNormals).

virtual double vtkPolygonalSurfacePointPlacer::GetDistanceOffset ( )
virtual

Height offset at which points may be placed on the polygonal surface.

If you specify a non-zero value here, be sure to compute cell normals on your input polygonal data (easily done with vtkPolyDataNormals).

virtual void vtkPolygonalSurfacePointPlacer::SetSnapToClosestPoint ( int  )
virtual

Snap to the closest point on the surface ? This is useful for the vtkPolygonalSurfaceContourLineInterpolator, when drawing contours along the edges of a surface mesh.

OFF by default.

virtual int vtkPolygonalSurfacePointPlacer::GetSnapToClosestPoint ( )
virtual

Snap to the closest point on the surface ? This is useful for the vtkPolygonalSurfaceContourLineInterpolator, when drawing contours along the edges of a surface mesh.

OFF by default.

virtual void vtkPolygonalSurfacePointPlacer::SnapToClosestPointOn ( )
virtual

Snap to the closest point on the surface ? This is useful for the vtkPolygonalSurfaceContourLineInterpolator, when drawing contours along the edges of a surface mesh.

OFF by default.

virtual void vtkPolygonalSurfacePointPlacer::SnapToClosestPointOff ( )
virtual

Snap to the closest point on the surface ? This is useful for the vtkPolygonalSurfaceContourLineInterpolator, when drawing contours along the edges of a surface mesh.

OFF by default.

Node* vtkPolygonalSurfacePointPlacer::GetNodeAtWorldPosition ( double  worldPos[3])

Internally used by the interpolator.

Member Data Documentation

vtkCellPicker* vtkPolygonalSurfacePointPlacer::CellPicker
protected

Definition at line 182 of file vtkPolygonalSurfacePointPlacer.h.

vtkPolyDataCollection* vtkPolygonalSurfacePointPlacer::Polys
protected

Definition at line 183 of file vtkPolygonalSurfacePointPlacer.h.

vtkPolygonalSurfacePointPlacerInternals* vtkPolygonalSurfacePointPlacer::Internals
protected

Definition at line 184 of file vtkPolygonalSurfacePointPlacer.h.

double vtkPolygonalSurfacePointPlacer::DistanceOffset
protected

Definition at line 185 of file vtkPolygonalSurfacePointPlacer.h.

int vtkPolygonalSurfacePointPlacer::SnapToClosestPoint
protected

Definition at line 186 of file vtkPolygonalSurfacePointPlacer.h.


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