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
vtkRibbonFilter Class Reference

create oriented ribbons from lines defined in polygonal dataset More...

#include <vtkRibbonFilter.h>

Inherits vtkPolyDataAlgorithm.

Public Types

typedef vtkPolyDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkRibbonFilterNewInstance () const
 
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 ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkRibbonFilterSafeDownCast (vtkObjectBase *o)
 
static vtkRibbonFilterNew ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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
 

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 59 of file vtkRibbonFilter.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkRibbonFilter::Superclass

Definition at line 62 of file vtkRibbonFilter.h.

Constructor & Destructor Documentation

vtkRibbonFilter::vtkRibbonFilter ( )
protected
vtkRibbonFilter::~vtkRibbonFilter ( )
protected

Member Function Documentation

static int vtkRibbonFilter::IsTypeOf ( const char *  type)
static
virtual int vtkRibbonFilter::IsA ( const char *  type)
virtual
static vtkRibbonFilter* vtkRibbonFilter::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkRibbonFilter::NewInstanceInternal ( ) const
protectedvirtual
vtkRibbonFilter* vtkRibbonFilter::NewInstance ( ) const
void vtkRibbonFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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.

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. The default is 0.5

virtual double vtkRibbonFilter::GetWidth ( )
virtual

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

virtual void vtkRibbonFilter::SetAngle ( double  )
virtual

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

virtual double vtkRibbonFilter::GetAngle ( )
virtual

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

virtual void vtkRibbonFilter::SetVaryWidth ( int  )
virtual

Turn on/off the variation of ribbon width with scalar value. The default is Off

virtual int vtkRibbonFilter::GetVaryWidth ( )
virtual

Turn on/off the variation of ribbon width with scalar value. The default is Off

virtual void vtkRibbonFilter::VaryWidthOn ( )
virtual

Turn on/off the variation of ribbon width with scalar value. The default is Off

virtual void vtkRibbonFilter::VaryWidthOff ( )
virtual

Turn on/off the variation of ribbon width with scalar value. The default is Off

virtual void vtkRibbonFilter::SetWidthFactor ( double  )
virtual

Set the maximum ribbon width in terms of a multiple of the minimum width. The default is 2.0

virtual double vtkRibbonFilter::GetWidthFactor ( )
virtual

Set the maximum ribbon width in terms of a multiple of the minimum width. The default is 2.0

virtual void vtkRibbonFilter::SetDefaultNormal ( double  ,
double  ,
double   
)
virtual

Set the default normal to use if no normals are supplied, and DefaultNormalOn is set. The default is (0,0,1)

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

Set the default normal to use if no normals are supplied, and DefaultNormalOn is set. The default is (0,0,1)

virtual double* vtkRibbonFilter::GetDefaultNormal ( )
virtual

Set the default normal to use if no normals are supplied, and DefaultNormalOn is set. The default is (0,0,1)

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

Set the default normal to use if no normals are supplied, and DefaultNormalOn is set. The default is (0,0,1)

virtual void vtkRibbonFilter::SetUseDefaultNormal ( int  )
virtual

Set a boolean to control whether to use default normals. The default is Off

virtual int vtkRibbonFilter::GetUseDefaultNormal ( )
virtual

Set a boolean to control whether to use default normals. The default is Off

virtual void vtkRibbonFilter::UseDefaultNormalOn ( )
virtual

Set a boolean to control whether to use default normals. The default is Off

virtual void vtkRibbonFilter::UseDefaultNormalOff ( )
virtual

Set a boolean to control whether to use default normals. The default is Off

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 119 of file vtkRibbonFilter.h.

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 121 of file vtkRibbonFilter.h.

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 123 of file vtkRibbonFilter.h.

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 125 of file vtkRibbonFilter.h.

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. The default is 1.0

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. The default is 1.0

int vtkRibbonFilter::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected
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 144 of file vtkRibbonFilter.h.

double vtkRibbonFilter::Angle
protected

Definition at line 145 of file vtkRibbonFilter.h.

int vtkRibbonFilter::VaryWidth
protected

Definition at line 146 of file vtkRibbonFilter.h.

double vtkRibbonFilter::WidthFactor
protected

Definition at line 147 of file vtkRibbonFilter.h.

double vtkRibbonFilter::DefaultNormal[3]
protected

Definition at line 148 of file vtkRibbonFilter.h.

int vtkRibbonFilter::UseDefaultNormal
protected

Definition at line 149 of file vtkRibbonFilter.h.

int vtkRibbonFilter::GenerateTCoords
protected

Definition at line 150 of file vtkRibbonFilter.h.

double vtkRibbonFilter::TextureLength
protected

Definition at line 151 of file vtkRibbonFilter.h.

double vtkRibbonFilter::Theta
protected

Definition at line 168 of file vtkRibbonFilter.h.


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