vtkLassoStencilSource Class Reference

#include <vtkLassoStencilSource.h>

Inheritance diagram for vtkLassoStencilSource:

Inheritance graph
[legend]
Collaboration diagram for vtkLassoStencilSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

Create a stencil from a contour.

vtkLassoStencilSource will create an image stencil from a set of points that define a contour. Its output can be used with vtkImageStecil or other vtk classes that apply a stencil to an image.

See also:
vtkROIStencilSource vtkPolyDataToImageStencil
Thanks:
Thanks to David Gobbi for contributing this class to VTK.
Tests:
vtkLassoStencilSource (Tests)

Definition at line 41 of file vtkLassoStencilSource.h.


Public Types

enum  { POLYGON = 0, SPLINE = 1 }
typedef vtkImageStencilSource Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void RemoveAllSlicePoints ()
unsigned long GetMTime ()
virtual int GetShape ()
virtual void SetShape (int)
void SetShapeToPolygon ()
void SetShapeToSpline ()
virtual const char * GetShapeAsString ()
virtual void SetPoints (vtkPoints *points)
virtual vtkPointsGetPoints ()
virtual int GetSliceOrientation ()
virtual void SetSliceOrientation (int)
virtual void SetSlicePoints (int i, vtkPoints *points)
virtual vtkPointsGetSlicePoints (int i)

Static Public Member Functions

static vtkLassoStencilSourceNew ()
static int IsTypeOf (const char *type)
static vtkLassoStencilSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkLassoStencilSource ()
 ~vtkLassoStencilSource ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

int Shape
int SliceOrientation
vtkPointsPoints
vtkSplineSplineX
vtkSplineSplineY
vtkLSSPointMap * PointMap

Member Typedef Documentation

Reimplemented from vtkImageStencilSource.

Definition at line 45 of file vtkLassoStencilSource.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
POLYGON 
SPLINE 

Definition at line 49 of file vtkLassoStencilSource.h.


Constructor & Destructor Documentation

vtkLassoStencilSource::vtkLassoStencilSource (  )  [protected]

vtkLassoStencilSource::~vtkLassoStencilSource (  )  [protected]


Member Function Documentation

static vtkLassoStencilSource* vtkLassoStencilSource::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkImageStencilSource.

virtual const char* vtkLassoStencilSource::GetClassName (  )  [virtual]

Reimplemented from vtkImageStencilSource.

static int vtkLassoStencilSource::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 vtkImageStencilSource.

virtual int vtkLassoStencilSource::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 vtkImageStencilSource.

static vtkLassoStencilSource* vtkLassoStencilSource::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkImageStencilSource.

void vtkLassoStencilSource::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 vtkImageStencilSource.

virtual int vtkLassoStencilSource::GetShape (  )  [virtual]

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

virtual void vtkLassoStencilSource::SetShape ( int   )  [virtual]

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

void vtkLassoStencilSource::SetShapeToPolygon (  )  [inline]

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

Definition at line 60 of file vtkLassoStencilSource.h.

void vtkLassoStencilSource::SetShapeToSpline (  )  [inline]

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

Definition at line 61 of file vtkLassoStencilSource.h.

virtual const char* vtkLassoStencilSource::GetShapeAsString (  )  [virtual]

The shape to use, default is "Polygon". The spline is a cardinal spline. Bezier splines are not yet supported.

virtual void vtkLassoStencilSource::SetPoints ( vtkPoints points  )  [virtual]

The points that make up the lassoo. The loop does not have to be closed, the last point will automatically be connected to the first point by a straight line segment.

virtual vtkPoints* vtkLassoStencilSource::GetPoints (  )  [virtual]

The points that make up the lassoo. The loop does not have to be closed, the last point will automatically be connected to the first point by a straight line segment.

virtual int vtkLassoStencilSource::GetSliceOrientation (  )  [virtual]

The slice orientation. The default is 2, which is XY. Other values are 0, which is YZ, and 1, which is XZ.

virtual void vtkLassoStencilSource::SetSliceOrientation ( int   )  [virtual]

The slice orientation. The default is 2, which is XY. Other values are 0, which is YZ, and 1, which is XZ.

virtual void vtkLassoStencilSource::SetSlicePoints ( int  i,
vtkPoints points 
) [virtual]

The points for a particular slice. This will override the points that were set by calling SetPoints() for the slice. To clear the setting, call SetSlicePoints(slice, NULL).

virtual vtkPoints* vtkLassoStencilSource::GetSlicePoints ( int  i  )  [virtual]

The points for a particular slice. This will override the points that were set by calling SetPoints() for the slice. To clear the setting, call SetSlicePoints(slice, NULL).

virtual void vtkLassoStencilSource::RemoveAllSlicePoints (  )  [virtual]

Remove points from all slices.

unsigned long vtkLassoStencilSource::GetMTime (  )  [virtual]

Overload GetMTime() to include the timestamp on the points.

Reimplemented from vtkObject.

virtual int vtkLassoStencilSource::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageStencilAlgorithm.


Member Data Documentation

Definition at line 101 of file vtkLassoStencilSource.h.

Definition at line 102 of file vtkLassoStencilSource.h.

Definition at line 103 of file vtkLassoStencilSource.h.

Definition at line 104 of file vtkLassoStencilSource.h.

Definition at line 105 of file vtkLassoStencilSource.h.

vtkLSSPointMap* vtkLassoStencilSource::PointMap [protected]

Definition at line 106 of file vtkLassoStencilSource.h.


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

Generated on Wed Aug 24 11:45:24 2011 for VTK by  doxygen 1.5.6