Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkRibbonFilter Class Reference

#include <vtkRibbonFilter.h>

Inheritance diagram for vtkRibbonFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkRibbonFilter:

Collaboration graph
[legend]
List of all members.

Detailed Description

create oriented ribbons from lines defined in polygonal dataset

vtkRibbonFilter is a filter to create oriented ribbons from lines defined in polygonal dataset. The orientation of the ribbon is along the line segments and perpendicular to "projected" line normals. Projected line normals are the original line normals projected to be perpendicular to the local line segment. An offset angle can be specified to rotate the ribbon with respect to the normal.

Warning:
The input line must not have duplicate points, or normals at points that are parallel to the incoming/outgoing line segments. (Duplicate points can be removed with vtkCleanPolyData.) If a line does not meet this criteria, then that line is not tubed.
See also:
vtkTubeFilter
Created by:
  • Schroeder, Will
CVS contributions (if > 5%):
  • Schroeder, Will (64%)
  • Martin, Ken (11%)
  • Law, Charles (7%)
  • Geveci, Berk (6%)
CVS logs (CVSweb):
  • .h (/Graphics/vtkRibbonFilter.h)
  • .cxx (/Graphics/vtkRibbonFilter.cxx)
Examples:
vtkRibbonFilter (Examples)
Tests:
vtkRibbonFilter (Tests)

Definition at line 71 of file vtkRibbonFilter.h.

Public Types

typedef vtkPolyDataToPolyDataFilter Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetWidth (double)
virtual double GetWidth ()
virtual void SetAngle (double)
virtual double GetAngle ()
virtual void SetVaryWidth (int)
virtual int GetVaryWidth ()
virtual void VaryWidthOn ()
virtual void VaryWidthOff ()
virtual void SetWidthFactor (double)
virtual double GetWidthFactor ()
virtual void SetDefaultNormal (double, double, double)
virtual void SetDefaultNormal (double[3])
virtual double * GetDefaultNormal ()
virtual void GetDefaultNormal (double data[3])
virtual void SetUseDefaultNormal (int)
virtual int GetUseDefaultNormal ()
virtual void UseDefaultNormalOn ()
virtual void UseDefaultNormalOff ()
virtual void SetGenerateTCoords (int)
virtual int GetGenerateTCoords ()
void SetGenerateTCoordsToOff ()
void SetGenerateTCoordsToNormalizedLength ()
void SetGenerateTCoordsToUseLength ()
void SetGenerateTCoordsToUseScalars ()
const char * GetGenerateTCoordsAsString ()
virtual void SetTextureLength (double)
virtual double GetTextureLength ()
virtual char * GetInputVectorsSelection ()
void SelectInputVectors (const char *fieldName)
virtual char * GetInputScalarsSelection ()
void SelectInputScalars (const char *fieldName)

Static Public Member Functions

int IsTypeOf (const char *type)
vtkRibbonFilterSafeDownCast (vtkObject *o)
vtkRibbonFilterNew ()

Protected Member Functions

 vtkRibbonFilter ()
 ~vtkRibbonFilter ()
void Execute ()
int GeneratePoints (vtkIdType offset, vtkIdType npts, vtkIdType *pts, vtkPoints *inPts, vtkPoints *newPts, vtkPointData *pd, vtkPointData *outPD, vtkFloatArray *newNormals, vtkDataArray *inScalars, double range[2], vtkDataArray *inNormals)
void GenerateStrip (vtkIdType offset, vtkIdType npts, vtkIdType *pts, vtkIdType inCellId, vtkCellData *cd, vtkCellData *outCD, vtkCellArray *newStrips)
void GenerateTextureCoords (vtkIdType offset, vtkIdType npts, vtkIdType *pts, vtkPoints *inPts, vtkDataArray *inScalars, vtkFloatArray *newTCoords)
vtkIdType ComputeOffset (vtkIdType offset, vtkIdType npts)
virtual void SetInputVectorsSelection (const char *)
virtual void SetInputScalarsSelection (const char *)

Protected Attributes

double Width
double Angle
int VaryWidth
double WidthFactor
double DefaultNormal [3]
int UseDefaultNormal
int GenerateTCoords
double TextureLength
double Theta
char * InputVectorsSelection
char * InputScalarsSelection


Member Typedef Documentation

typedef vtkPolyDataToPolyDataFilter vtkRibbonFilter::Superclass
 

Reimplemented from vtkPolyDataToPolyDataFilter.

Definition at line 74 of file vtkRibbonFilter.h.


Constructor & Destructor Documentation

vtkRibbonFilter::vtkRibbonFilter  )  [protected]
 

vtkRibbonFilter::~vtkRibbonFilter  )  [protected]
 


Member Function Documentation

virtual const char* vtkRibbonFilter::GetClassName  )  [virtual]
 

Reimplemented from vtkPolyDataToPolyDataFilter.

int vtkRibbonFilter::IsTypeOf const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

virtual int vtkRibbonFilter::IsA const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

vtkRibbonFilter* vtkRibbonFilter::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkPolyDataToPolyDataFilter.

void vtkRibbonFilter::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 vtkPolyDataToPolyDataFilter.

vtkRibbonFilter* vtkRibbonFilter::New  )  [static]
 

Construct ribbon so that width is 0.1, the width does not vary with scalar values, and the width factor is 2.0.

Reimplemented from vtkAlgorithm.

virtual void vtkRibbonFilter::SetWidth double   )  [virtual]
 

Set the "half" width of the ribbon. If the width is allowed to vary, this is the minimum width.

virtual double vtkRibbonFilter::GetWidth  )  [virtual]
 

Set the "half" width of the ribbon. If the width is allowed to vary, this is the minimum width.

virtual void vtkRibbonFilter::SetAngle double   )  [virtual]
 

Set the offset angle of the ribbon from the line normal. (The angle is expressed in degrees.)

virtual double vtkRibbonFilter::GetAngle  )  [virtual]
 

Set the offset angle of the ribbon from the line normal. (The angle is expressed in degrees.)

virtual void vtkRibbonFilter::SetVaryWidth int   )  [virtual]
 

Turn on/off the variation of ribbon width with scalar value.

virtual int vtkRibbonFilter::GetVaryWidth  )  [virtual]
 

Turn on/off the variation of ribbon width with scalar value.

virtual void vtkRibbonFilter::VaryWidthOn  )  [virtual]
 

Turn on/off the variation of ribbon width with scalar value.

virtual void vtkRibbonFilter::VaryWidthOff  )  [virtual]
 

Turn on/off the variation of ribbon width with scalar value.

virtual void vtkRibbonFilter::SetWidthFactor double   )  [virtual]
 

Set the maximum ribbon width in terms of a multiple of the minimum width.

virtual double vtkRibbonFilter::GetWidthFactor  )  [virtual]
 

Set the maximum ribbon width in terms of a multiple of the minimum width.

virtual void vtkRibbonFilter::SetDefaultNormal double  ,
double  ,
double 
[virtual]
 

Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set.

virtual void vtkRibbonFilter::SetDefaultNormal double  [3]  )  [virtual]
 

Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set.

virtual double* vtkRibbonFilter::GetDefaultNormal  )  [virtual]
 

Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set.

virtual void vtkRibbonFilter::GetDefaultNormal double  data[3]  )  [virtual]
 

Set the default normal to use if no normals are supplied, and the DefaultNormalOn is set.

virtual void vtkRibbonFilter::SetUseDefaultNormal int   )  [virtual]
 

Set a boolean to control whether to use default normals. DefaultNormalOn is set.

virtual int vtkRibbonFilter::GetUseDefaultNormal  )  [virtual]
 

Set a boolean to control whether to use default normals. DefaultNormalOn is set.

virtual void vtkRibbonFilter::UseDefaultNormalOn  )  [virtual]
 

Set a boolean to control whether to use default normals. DefaultNormalOn is set.

virtual void vtkRibbonFilter::UseDefaultNormalOff  )  [virtual]
 

Set a boolean to control whether to use default normals. DefaultNormalOn is set.

virtual void vtkRibbonFilter::SetGenerateTCoords int   )  [virtual]
 

Control whether and how texture coordinates are produced. This is useful for striping the ribbon with time textures, etc.

virtual int vtkRibbonFilter::GetGenerateTCoords  )  [virtual]
 

Control whether and how texture coordinates are produced. This is useful for striping the ribbon with time textures, etc.

void vtkRibbonFilter::SetGenerateTCoordsToOff  )  [inline]
 

Control whether and how texture coordinates are produced. This is useful for striping the ribbon with time textures, etc.

Definition at line 130 of file vtkRibbonFilter.h.

References VTK_TCOORDS_OFF.

void vtkRibbonFilter::SetGenerateTCoordsToNormalizedLength  )  [inline]
 

Control whether and how texture coordinates are produced. This is useful for striping the ribbon with time textures, etc.

Definition at line 132 of file vtkRibbonFilter.h.

References VTK_TCOORDS_FROM_NORMALIZED_LENGTH.

void vtkRibbonFilter::SetGenerateTCoordsToUseLength  )  [inline]
 

Control whether and how texture coordinates are produced. This is useful for striping the ribbon with time textures, etc.

Definition at line 134 of file vtkRibbonFilter.h.

References VTK_TCOORDS_FROM_LENGTH.

void vtkRibbonFilter::SetGenerateTCoordsToUseScalars  )  [inline]
 

Control whether and how texture coordinates are produced. This is useful for striping the ribbon with time textures, etc.

Definition at line 136 of file vtkRibbonFilter.h.

References VTK_TCOORDS_FROM_SCALARS.

const char* vtkRibbonFilter::GetGenerateTCoordsAsString  ) 
 

Control whether and how texture coordinates are produced. This is useful for striping the ribbon with time textures, etc.

virtual void vtkRibbonFilter::SetTextureLength double   )  [virtual]
 

Control the conversion of units during the texture coordinates calculation. The TextureLength indicates what length (whether calculated from scalars or length) is mapped to the [0,1) texture space.

virtual double vtkRibbonFilter::GetTextureLength  )  [virtual]
 

Control the conversion of units during the texture coordinates calculation. The TextureLength indicates what length (whether calculated from scalars or length) is mapped to the [0,1) texture space.

virtual char* vtkRibbonFilter::GetInputVectorsSelection  )  [virtual]
 

If you want to use an arbitrary normals array, then set its name here. By default this in NULL and the filter will use the active normal array.

void vtkRibbonFilter::SelectInputVectors const char *  fieldName  )  [inline]
 

If you want to use an arbitrary normals array, then set its name here. By default this in NULL and the filter will use the active normal array.

Definition at line 155 of file vtkRibbonFilter.h.

virtual char* vtkRibbonFilter::GetInputScalarsSelection  )  [virtual]
 

If you want to use an arbitrary scalars array, then set its name here. By default this in NULL and the filter will use the active scalars array.

void vtkRibbonFilter::SelectInputScalars const char *  fieldName  )  [inline]
 

If you want to use an arbitrary scalars array, then set its name here. By default this in NULL and the filter will use the active scalars array.

Definition at line 164 of file vtkRibbonFilter.h.

void vtkRibbonFilter::Execute  )  [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.

int vtkRibbonFilter::GeneratePoints vtkIdType  offset,
vtkIdType  npts,
vtkIdType pts,
vtkPoints inPts,
vtkPoints newPts,
vtkPointData pd,
vtkPointData outPD,
vtkFloatArray newNormals,
vtkDataArray inScalars,
double  range[2],
vtkDataArray inNormals
[protected]
 

void vtkRibbonFilter::GenerateStrip vtkIdType  offset,
vtkIdType  npts,
vtkIdType pts,
vtkIdType  inCellId,
vtkCellData cd,
vtkCellData outCD,
vtkCellArray newStrips
[protected]
 

void vtkRibbonFilter::GenerateTextureCoords vtkIdType  offset,
vtkIdType  npts,
vtkIdType pts,
vtkPoints inPts,
vtkDataArray inScalars,
vtkFloatArray newTCoords
[protected]
 

vtkIdType vtkRibbonFilter::ComputeOffset vtkIdType  offset,
vtkIdType  npts
[protected]
 

virtual void vtkRibbonFilter::SetInputVectorsSelection const char *   )  [protected, virtual]
 

virtual void vtkRibbonFilter::SetInputScalarsSelection const char *   )  [protected, virtual]
 


Member Data Documentation

double vtkRibbonFilter::Width [protected]
 

Definition at line 173 of file vtkRibbonFilter.h.

double vtkRibbonFilter::Angle [protected]
 

Definition at line 174 of file vtkRibbonFilter.h.

int vtkRibbonFilter::VaryWidth [protected]
 

Definition at line 175 of file vtkRibbonFilter.h.

double vtkRibbonFilter::WidthFactor [protected]
 

Definition at line 176 of file vtkRibbonFilter.h.

double vtkRibbonFilter::DefaultNormal[3] [protected]
 

Definition at line 177 of file vtkRibbonFilter.h.

int vtkRibbonFilter::UseDefaultNormal [protected]
 

Definition at line 178 of file vtkRibbonFilter.h.

int vtkRibbonFilter::GenerateTCoords [protected]
 

Definition at line 179 of file vtkRibbonFilter.h.

double vtkRibbonFilter::TextureLength [protected]
 

Definition at line 180 of file vtkRibbonFilter.h.

double vtkRibbonFilter::Theta [protected]
 

Definition at line 197 of file vtkRibbonFilter.h.

char* vtkRibbonFilter::InputVectorsSelection [protected]
 

Definition at line 201 of file vtkRibbonFilter.h.

char* vtkRibbonFilter::InputScalarsSelection [protected]
 

Definition at line 204 of file vtkRibbonFilter.h.


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