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

extract points that are visible (based on z-buffer calculation) More...

#include <vtkSelectVisiblePoints.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
float * Initialize (bool getZbuff)
bool IsPointOccluded (const double x[], float *zPtr)
unsigned long GetMTime ()
void SetRenderer (vtkRenderer *ren)
vtkRendererGetRenderer ()
virtual void SetSelectionWindow (int)
virtual int GetSelectionWindow ()
virtual void SelectionWindowOn ()
virtual void SelectionWindowOff ()
virtual void SetSelection (int, int, int, int)
virtual void SetSelection (int[4])
virtual int * GetSelection ()
virtual void GetSelection (int data[4])
virtual void SetSelectInvisible (int)
virtual int GetSelectInvisible ()
virtual void SelectInvisibleOn ()
virtual void SelectInvisibleOff ()
virtual void SetTolerance (double)
virtual double GetTolerance ()
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkPolyDataGetPolyDataInput (int port)
vtkPolyDataGetOutput ()
vtkPolyDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
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)
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 int IsTypeOf (const char *type)
static vtkSelectVisiblePointsSafeDownCast (vtkObject *o)
static vtkSelectVisiblePointsNew ()

Protected Member Functions

 vtkSelectVisiblePoints ()
 ~vtkSelectVisiblePoints ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int FillInputPortInformation (int port, vtkInformation *info)
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 ~vtkPolyDataAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- 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)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkRendererRenderer
vtkMatrix4x4CompositePerspectiveTransform
int SelectionWindow
int Selection [4]
int InternalSelection [4]
int SelectInvisible
double Tolerance

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

Detailed Description

extract points that are visible (based on z-buffer calculation)

vtkSelectVisiblePoints is a filter that selects points based on whether they are visible or not. Visibility is determined by accessing the z-buffer of a rendering window. (The position of each input point is converted into display coordinates, and then the z-value at that point is obtained. If within the user-specified tolerance, the point is considered visible.)

Points that are visible (or if the ivar SelectInvisible is on, invisible points) are passed to the output. Associated data attributes are passed to the output as well.

This filter also allows you to specify a rectangular window in display (pixel) coordinates in which the visible points must lie. This can be used as a sort of local "brushing" operation to select just data within a window.

Warning
You must carefully synchronize the execution of this filter. The filter refers to a renderer, which is modified every time a render occurs. Therefore, the filter is always out of date, and always executes. You may have to perform two rendering passes, or if you are using this filter in conjunction with vtkLabeledDataMapper, things work out because 2D rendering occurs after the 3D rendering.
Examples:
vtkSelectVisiblePoints (Examples)
Tests:
vtkSelectVisiblePoints (Tests)

Definition at line 58 of file vtkSelectVisiblePoints.h.

Member Typedef Documentation

Definition at line 61 of file vtkSelectVisiblePoints.h.

Constructor & Destructor Documentation

vtkSelectVisiblePoints::vtkSelectVisiblePoints ( )
protected
vtkSelectVisiblePoints::~vtkSelectVisiblePoints ( )
protected

Member Function Documentation

virtual const char* vtkSelectVisiblePoints::GetClassName ( )
virtual

Reimplemented from vtkPolyDataAlgorithm.

static int vtkSelectVisiblePoints::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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 vtkPolyDataAlgorithm.

virtual int vtkSelectVisiblePoints::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 vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

void vtkSelectVisiblePoints::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 vtkPolyDataAlgorithm.

static vtkSelectVisiblePoints* vtkSelectVisiblePoints::New ( )
static

Instantiate object with no renderer; window selection turned off; tolerance set to 0.01; and select invisible off.

Reimplemented from vtkPolyDataAlgorithm.

void vtkSelectVisiblePoints::SetRenderer ( vtkRenderer ren)
inline

Specify the renderer in which the visibility computation is to be performed.

Definition at line 71 of file vtkSelectVisiblePoints.h.

vtkRenderer* vtkSelectVisiblePoints::GetRenderer ( )
inline

Specify the renderer in which the visibility computation is to be performed.

Definition at line 79 of file vtkSelectVisiblePoints.h.

virtual void vtkSelectVisiblePoints::SetSelectionWindow ( int  )
virtual

Set/Get the flag which enables selection in a rectangular display region.

virtual int vtkSelectVisiblePoints::GetSelectionWindow ( )
virtual

Set/Get the flag which enables selection in a rectangular display region.

virtual void vtkSelectVisiblePoints::SelectionWindowOn ( )
virtual

Set/Get the flag which enables selection in a rectangular display region.

virtual void vtkSelectVisiblePoints::SelectionWindowOff ( )
virtual

Set/Get the flag which enables selection in a rectangular display region.

virtual void vtkSelectVisiblePoints::SetSelection ( int  ,
int  ,
int  ,
int   
)
virtual

Specify the selection window in display coordinates. You must specify a rectangular region using (xmin,xmax,ymin,ymax).

virtual void vtkSelectVisiblePoints::SetSelection ( int  [4])
virtual

Specify the selection window in display coordinates. You must specify a rectangular region using (xmin,xmax,ymin,ymax).

virtual int* vtkSelectVisiblePoints::GetSelection ( )
virtual

Specify the selection window in display coordinates. You must specify a rectangular region using (xmin,xmax,ymin,ymax).

virtual void vtkSelectVisiblePoints::GetSelection ( int  data[4])
virtual

Specify the selection window in display coordinates. You must specify a rectangular region using (xmin,xmax,ymin,ymax).

virtual void vtkSelectVisiblePoints::SetSelectInvisible ( int  )
virtual

Set/Get the flag which enables inverse selection; i.e., invisible points are selected.

virtual int vtkSelectVisiblePoints::GetSelectInvisible ( )
virtual

Set/Get the flag which enables inverse selection; i.e., invisible points are selected.

virtual void vtkSelectVisiblePoints::SelectInvisibleOn ( )
virtual

Set/Get the flag which enables inverse selection; i.e., invisible points are selected.

virtual void vtkSelectVisiblePoints::SelectInvisibleOff ( )
virtual

Set/Get the flag which enables inverse selection; i.e., invisible points are selected.

virtual void vtkSelectVisiblePoints::SetTolerance ( double  )
virtual

Set/Get a tolerance to use to determine whether a point is visible. A tolerance is usually required because the conversion from world space to display space during rendering introduces numerical round-off.

virtual double vtkSelectVisiblePoints::GetTolerance ( )
virtual

Set/Get a tolerance to use to determine whether a point is visible. A tolerance is usually required because the conversion from world space to display space during rendering introduces numerical round-off.

float* vtkSelectVisiblePoints::Initialize ( bool  getZbuff)

Requires the renderer to be set. Populates the composite perspective transform and returns a pointer to the Z-buffer (that must be deleted) if getZbuff is set.

bool vtkSelectVisiblePoints::IsPointOccluded ( const double  x[],
float *  zPtr 
)

Tests if a point x is being occluded or not against the Z-Buffer array passed in by zPtr. Call Initialize before calling this method.

unsigned long vtkSelectVisiblePoints::GetMTime ( )
virtual

Return MTime also considering the renderer.

Reimplemented from vtkObject.

virtual int vtkSelectVisiblePoints::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkSelectVisiblePoints::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

vtkRenderer* vtkSelectVisiblePoints::Renderer
protected

Definition at line 132 of file vtkSelectVisiblePoints.h.

vtkMatrix4x4* vtkSelectVisiblePoints::CompositePerspectiveTransform
protected

Definition at line 133 of file vtkSelectVisiblePoints.h.

int vtkSelectVisiblePoints::SelectionWindow
protected

Definition at line 135 of file vtkSelectVisiblePoints.h.

int vtkSelectVisiblePoints::Selection[4]
protected

Definition at line 136 of file vtkSelectVisiblePoints.h.

int vtkSelectVisiblePoints::InternalSelection[4]
protected

Definition at line 137 of file vtkSelectVisiblePoints.h.

int vtkSelectVisiblePoints::SelectInvisible
protected

Definition at line 138 of file vtkSelectVisiblePoints.h.

double vtkSelectVisiblePoints::Tolerance
protected

Definition at line 139 of file vtkSelectVisiblePoints.h.


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