vtkRibbonFilter Class Reference

#include <vtkRibbonFilter.h>

Inheritance diagram for vtkRibbonFilter:

[legend]Collaboration diagram for vtkRibbonFilter:

[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

Examples:

vtkRibbonFilter (Examples)

Tests:

vtkRibbonFilter (Tests)

Definition at line 58 of file vtkRibbonFilter.h.

virtual void	SetWidth (double)
virtual double	GetWidth ()
static vtkRibbonFilter *	New ()
Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
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 ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkRibbonFilter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkRibbonFilter ()
	~vtkRibbonFilter ()
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
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)
Protected Attributes
double	Width
double	Angle
int	VaryWidth
double	WidthFactor
double	DefaultNormal [3]
int	UseDefaultNormal
int	GenerateTCoords
double	TextureLength
double	Theta

---

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkRibbonFilter::Superclass

Reimplemented from vtkPolyDataAlgorithm. Definition at line 61 of file vtkRibbonFilter.h.

---

Constructor & Destructor Documentation

vtkRibbonFilter::vtkRibbonFilter (   )  [protected]

vtkRibbonFilter::~vtkRibbonFilter (   )  [protected]

---

Member Function Documentation

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

Reimplemented from vtkPolyDataAlgorithm.

static 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 vtkPolyDataAlgorithm.

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 vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

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 vtkPolyDataAlgorithm.

static 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 vtkPolyDataAlgorithm.

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 117 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 119 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 121 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 123 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.

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

This is called by the superclass. This is the method you should override. Reimplemented from vtkPolyDataAlgorithm.

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]

---

Member Data Documentation

double vtkRibbonFilter::Width [protected]

Definition at line 142 of file vtkRibbonFilter.h.

double vtkRibbonFilter::Angle [protected]

Definition at line 143 of file vtkRibbonFilter.h.

int vtkRibbonFilter::VaryWidth [protected]

Definition at line 144 of file vtkRibbonFilter.h.

double vtkRibbonFilter::WidthFactor [protected]

Definition at line 145 of file vtkRibbonFilter.h.

double vtkRibbonFilter::DefaultNormal[3] [protected]

Definition at line 146 of file vtkRibbonFilter.h.

int vtkRibbonFilter::UseDefaultNormal [protected]

Definition at line 147 of file vtkRibbonFilter.h.

int vtkRibbonFilter::GenerateTCoords [protected]

Definition at line 148 of file vtkRibbonFilter.h.

double vtkRibbonFilter::TextureLength [protected]

Definition at line 149 of file vtkRibbonFilter.h.

double vtkRibbonFilter::Theta [protected]

Definition at line 166 of file vtkRibbonFilter.h.

---

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

• dox/Graphics/vtkRibbonFilter.h

---