VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkRuledSurfaceFilter Class Reference

generates a surface from a set of lines More...

#include <vtkRuledSurfaceFilter.h>

Inherits vtkPolyDataAlgorithm.

Public Types

typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkRuledSurfaceFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetDistanceFactor (double)
 
virtual double GetDistanceFactor ()
 
virtual void SetOnRatio (int)
 
virtual int GetOnRatio ()
 
virtual void SetOffset (int)
 
virtual int GetOffset ()
 
virtual void SetCloseSurface (int)
 
virtual int GetCloseSurface ()
 
virtual void CloseSurfaceOn ()
 
virtual void CloseSurfaceOff ()
 
virtual void SetRuledMode (int)
 
virtual int GetRuledMode ()
 
void SetRuledModeToResample ()
 
void SetRuledModeToPointWalk ()
 
const char * GetRuledModeAsString ()
 
virtual void SetResolution (int, int)
 
void SetResolution (int[2])
 
virtual int * GetResolution ()
 
virtual void GetResolution (int data[2])
 
virtual void SetPassLines (int)
 
virtual int GetPassLines ()
 
virtual void PassLinesOn ()
 
virtual void PassLinesOff ()
 
virtual void SetOrientLoops (int)
 
virtual int GetOrientLoops ()
 
virtual void OrientLoopsOn ()
 
virtual void OrientLoopsOff ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkRuledSurfaceFilterSafeDownCast (vtkObjectBase *o)
 
static vtkRuledSurfaceFilterNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkRuledSurfaceFilter ()
 
 ~vtkRuledSurfaceFilter ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

double DistanceFactor
 
int OnRatio
 
int Offset
 
int CloseSurface
 
int RuledMode
 
int Resolution [2]
 
int PassLines
 
int OrientLoops
 

Detailed Description

generates a surface from a set of lines

vtkRuledSurfaceFilter is a filter that generates a surface from a set of lines. The lines are assumed to be "parallel" in the sense that they do not intersect and remain somewhat close to one another. A surface is generated by connecting the points defining each pair of lines with straight lines. This creates a strip for each pair of lines (i.e., a triangulation is created from two generating lines). The filter can handle an arbitrary number of lines, with lines i and i+1 assumed connected. Note that there are several different approaches for creating the ruled surface, the method for creating the surface can either use the input points or resample from the polylines (using a user-specified resolution).

This filter offers some other important features. A DistanceFactor ivar is used to decide when two lines are too far apart to connect. (The factor is a multiple of the distance between the first two points of the two lines defining the strip.) If the distance between the two generating lines becomes too great, then the surface is not generated in that region. (Note: if the lines separate and then merge, then a hole can be generated in the surface.) In addition, the Offset and OnRation ivars can be used to create nifty striped surfaces. Closed surfaces (e.g., tubes) can be created by setting the CloseSurface ivar. (The surface can be closed in the other direction by repeating the first and last point in the polylines defining the surface.)

An important use of this filter is to combine it with vtkStreamLine to generate stream surfaces. It can also be used to create surfaces from contours.

Warning
The number of lines must be greater than two if a surface is to be generated. sides (i.e., a ribbon), use vtkRibbonFilter.
See Also
vtkRibbonFilter vtkStreamLine
Examples:
vtkRuledSurfaceFilter (Examples)
Tests:
vtkRuledSurfaceFilter (Tests)

Definition at line 72 of file vtkRuledSurfaceFilter.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkRuledSurfaceFilter::Superclass

Definition at line 75 of file vtkRuledSurfaceFilter.h.

Constructor & Destructor Documentation

vtkRuledSurfaceFilter::vtkRuledSurfaceFilter ( )
protected
vtkRuledSurfaceFilter::~vtkRuledSurfaceFilter ( )
protected

Member Function Documentation

static int vtkRuledSurfaceFilter::IsTypeOf ( const char *  type)
static
virtual int vtkRuledSurfaceFilter::IsA ( const char *  type)
virtual
static vtkRuledSurfaceFilter* vtkRuledSurfaceFilter::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkRuledSurfaceFilter::NewInstanceInternal ( ) const
protectedvirtual
vtkRuledSurfaceFilter* vtkRuledSurfaceFilter::NewInstance ( ) const
void vtkRuledSurfaceFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static vtkRuledSurfaceFilter* vtkRuledSurfaceFilter::New ( )
static

Construct object with OnRatio=1, Offset=0. DistanceFactor=3.0, CloseSurface off, and PassLines off.

virtual void vtkRuledSurfaceFilter::SetDistanceFactor ( double  )
virtual

Set/Get the factor that controls tearing of the surface.

virtual double vtkRuledSurfaceFilter::GetDistanceFactor ( )
virtual

Set/Get the factor that controls tearing of the surface.

virtual void vtkRuledSurfaceFilter::SetOnRatio ( int  )
virtual

Control the striping of the ruled surface. If OnRatio is greater than 1, then every nth strip is turned on, beginning with the Offset strip.

virtual int vtkRuledSurfaceFilter::GetOnRatio ( )
virtual

Control the striping of the ruled surface. If OnRatio is greater than 1, then every nth strip is turned on, beginning with the Offset strip.

virtual void vtkRuledSurfaceFilter::SetOffset ( int  )
virtual

Control the striping of the ruled surface. The offset sets the first stripe that is visible. Offset is generally used with OnRatio to create nifty striping effects.

virtual int vtkRuledSurfaceFilter::GetOffset ( )
virtual

Control the striping of the ruled surface. The offset sets the first stripe that is visible. Offset is generally used with OnRatio to create nifty striping effects.

virtual void vtkRuledSurfaceFilter::SetCloseSurface ( int  )
virtual

Indicate whether the surface is to be closed. If this boolean is on, then the first and last polyline are used to generate a stripe that closes the surface. (Note: to close the surface in the other direction, repeat the first point in the polyline as the last point in the polyline.)

virtual int vtkRuledSurfaceFilter::GetCloseSurface ( )
virtual

Indicate whether the surface is to be closed. If this boolean is on, then the first and last polyline are used to generate a stripe that closes the surface. (Note: to close the surface in the other direction, repeat the first point in the polyline as the last point in the polyline.)

virtual void vtkRuledSurfaceFilter::CloseSurfaceOn ( )
virtual

Indicate whether the surface is to be closed. If this boolean is on, then the first and last polyline are used to generate a stripe that closes the surface. (Note: to close the surface in the other direction, repeat the first point in the polyline as the last point in the polyline.)

virtual void vtkRuledSurfaceFilter::CloseSurfaceOff ( )
virtual

Indicate whether the surface is to be closed. If this boolean is on, then the first and last polyline are used to generate a stripe that closes the surface. (Note: to close the surface in the other direction, repeat the first point in the polyline as the last point in the polyline.)

virtual void vtkRuledSurfaceFilter::SetRuledMode ( int  )
virtual

Set the mode by which to create the ruled surface. (Dramatically different results are possible depending on the chosen mode.) The resample mode evenly resamples the polylines (based on length) and generates triangle strips. The point walk mode uses the existing points and walks around the polyline using existing points.

virtual int vtkRuledSurfaceFilter::GetRuledMode ( )
virtual

Set the mode by which to create the ruled surface. (Dramatically different results are possible depending on the chosen mode.) The resample mode evenly resamples the polylines (based on length) and generates triangle strips. The point walk mode uses the existing points and walks around the polyline using existing points.

void vtkRuledSurfaceFilter::SetRuledModeToResample ( )
inline

Set the mode by which to create the ruled surface. (Dramatically different results are possible depending on the chosen mode.) The resample mode evenly resamples the polylines (based on length) and generates triangle strips. The point walk mode uses the existing points and walks around the polyline using existing points.

Definition at line 124 of file vtkRuledSurfaceFilter.h.

void vtkRuledSurfaceFilter::SetRuledModeToPointWalk ( )
inline

Set the mode by which to create the ruled surface. (Dramatically different results are possible depending on the chosen mode.) The resample mode evenly resamples the polylines (based on length) and generates triangle strips. The point walk mode uses the existing points and walks around the polyline using existing points.

Definition at line 126 of file vtkRuledSurfaceFilter.h.

const char* vtkRuledSurfaceFilter::GetRuledModeAsString ( )

Set the mode by which to create the ruled surface. (Dramatically different results are possible depending on the chosen mode.) The resample mode evenly resamples the polylines (based on length) and generates triangle strips. The point walk mode uses the existing points and walks around the polyline using existing points.

virtual void vtkRuledSurfaceFilter::SetResolution ( int  ,
int   
)
virtual

If the ruled surface generation mode is RESAMPLE, then these parameters are used to determine the resample rate. Resolution[0] defines the resolution in the direction of the polylines; Resolution[1] defines the resolution across the polylines (i.e., direction orthogonal to Resolution[0]).

void vtkRuledSurfaceFilter::SetResolution ( int  [2])

If the ruled surface generation mode is RESAMPLE, then these parameters are used to determine the resample rate. Resolution[0] defines the resolution in the direction of the polylines; Resolution[1] defines the resolution across the polylines (i.e., direction orthogonal to Resolution[0]).

virtual int* vtkRuledSurfaceFilter::GetResolution ( )
virtual

If the ruled surface generation mode is RESAMPLE, then these parameters are used to determine the resample rate. Resolution[0] defines the resolution in the direction of the polylines; Resolution[1] defines the resolution across the polylines (i.e., direction orthogonal to Resolution[0]).

virtual void vtkRuledSurfaceFilter::GetResolution ( int  data[2])
virtual

If the ruled surface generation mode is RESAMPLE, then these parameters are used to determine the resample rate. Resolution[0] defines the resolution in the direction of the polylines; Resolution[1] defines the resolution across the polylines (i.e., direction orthogonal to Resolution[0]).

virtual void vtkRuledSurfaceFilter::SetPassLines ( int  )
virtual

Indicate whether the generating lines are to be passed to the output. By defualt lines are not passed to the output.

virtual int vtkRuledSurfaceFilter::GetPassLines ( )
virtual

Indicate whether the generating lines are to be passed to the output. By defualt lines are not passed to the output.

virtual void vtkRuledSurfaceFilter::PassLinesOn ( )
virtual

Indicate whether the generating lines are to be passed to the output. By defualt lines are not passed to the output.

virtual void vtkRuledSurfaceFilter::PassLinesOff ( )
virtual

Indicate whether the generating lines are to be passed to the output. By defualt lines are not passed to the output.

virtual void vtkRuledSurfaceFilter::SetOrientLoops ( int  )
virtual

Indicate whether the starting points of the loops need to be determined. If set to 0, then its assumes that the 0th point of each loop should be always connected By defualt the loops are not oriented.

virtual int vtkRuledSurfaceFilter::GetOrientLoops ( )
virtual

Indicate whether the starting points of the loops need to be determined. If set to 0, then its assumes that the 0th point of each loop should be always connected By defualt the loops are not oriented.

virtual void vtkRuledSurfaceFilter::OrientLoopsOn ( )
virtual

Indicate whether the starting points of the loops need to be determined. If set to 0, then its assumes that the 0th point of each loop should be always connected By defualt the loops are not oriented.

virtual void vtkRuledSurfaceFilter::OrientLoopsOff ( )
virtual

Indicate whether the starting points of the loops need to be determined. If set to 0, then its assumes that the 0th point of each loop should be always connected By defualt the loops are not oriented.

int vtkRuledSurfaceFilter::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

Member Data Documentation

double vtkRuledSurfaceFilter::DistanceFactor
protected

Definition at line 166 of file vtkRuledSurfaceFilter.h.

int vtkRuledSurfaceFilter::OnRatio
protected

Definition at line 167 of file vtkRuledSurfaceFilter.h.

int vtkRuledSurfaceFilter::Offset
protected

Definition at line 168 of file vtkRuledSurfaceFilter.h.

int vtkRuledSurfaceFilter::CloseSurface
protected

Definition at line 169 of file vtkRuledSurfaceFilter.h.

int vtkRuledSurfaceFilter::RuledMode
protected

Definition at line 170 of file vtkRuledSurfaceFilter.h.

int vtkRuledSurfaceFilter::Resolution[2]
protected

Definition at line 171 of file vtkRuledSurfaceFilter.h.

int vtkRuledSurfaceFilter::PassLines
protected

Definition at line 172 of file vtkRuledSurfaceFilter.h.

int vtkRuledSurfaceFilter::OrientLoops
protected

Definition at line 173 of file vtkRuledSurfaceFilter.h.


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