Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkRibbonFilter Class Reference

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

#include <vtkRibbonFilter.h>

Inheritance diagram for vtkRibbonFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkRibbonFilter:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetWidth (float)
virtual float GetWidth ()
virtual void SetAngle (float)
virtual float GetAngle ()
virtual void SetVaryWidth (int)
virtual int GetVaryWidth ()
virtual void VaryWidthOn ()
virtual void VaryWidthOff ()
virtual void SetWidthFactor (float)
virtual float GetWidthFactor ()
virtual void SetDefaultNormal (float, float, float)
virtual void SetDefaultNormal (float[3])
virtual float * GetDefaultNormal ()
virtual void GetDefaultNormal (float data[3])
virtual void SetUseDefaultNormal (int)
virtual int GetUseDefaultNormal ()
virtual void UseDefaultNormalOn ()
virtual void UseDefaultNormalOff ()

Static Public Methods

int IsTypeOf (const char *type)
vtkRibbonFilter * SafeDownCast (vtkObject *o)
vtkRibbonFilter * New ()

Protected Methods

 vtkRibbonFilter ()
 ~vtkRibbonFilter ()
void Execute ()

Protected Attributes

float Width
float Angle
int VaryWidth
float WidthFactor
float DefaultNormal [3]
int UseDefaultNormal

Detailed Description

create oriented ribbons from lines defined in polygonal dataset.

Date:
2001/10/11 13:37:13
Revision:
1.35

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.

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

See also:
vtkTubeFilter
Tests:
vtkRibbonFilter (Tests)

Definition at line 69 of file vtkRibbonFilter.h.


Constructor & Destructor Documentation

vtkRibbonFilter::vtkRibbonFilter   [protected]
 

vtkRibbonFilter::~vtkRibbonFilter   [inline, protected]
 

Definition at line 123 of file vtkRibbonFilter.h.


Member Function Documentation

virtual const char* vtkRibbonFilter::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

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 vtkTypeMacro 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

vtkRibbonFilter* vtkRibbonFilter::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

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

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

virtual void vtkRibbonFilter::SetWidth float    [virtual]
 

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

virtual float 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 float    [virtual]
 

Set the offset angle of the ribbon from the line normal.

virtual float vtkRibbonFilter::GetAngle   [virtual]
 

Set the offset angle of the ribbon from the line normal.

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 float    [virtual]
 

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

virtual float vtkRibbonFilter::GetWidthFactor   [virtual]
 

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

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

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

virtual void vtkRibbonFilter::SetDefaultNormal float   [3] [virtual]
 

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

virtual float* vtkRibbonFilter::GetDefaultNormal   [virtual]
 

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

virtual void vtkRibbonFilter::GetDefaultNormal float    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.

void vtkRibbonFilter::Execute   [protected, virtual]
 

This method is the old style execute method

Reimplemented from vtkSource.


Member Data Documentation

float vtkRibbonFilter::Width [protected]
 

Definition at line 126 of file vtkRibbonFilter.h.

float vtkRibbonFilter::Angle [protected]
 

Definition at line 127 of file vtkRibbonFilter.h.

int vtkRibbonFilter::VaryWidth [protected]
 

Definition at line 128 of file vtkRibbonFilter.h.

float vtkRibbonFilter::WidthFactor [protected]
 

Definition at line 129 of file vtkRibbonFilter.h.

float vtkRibbonFilter::DefaultNormal[3] [protected]
 

Definition at line 130 of file vtkRibbonFilter.h.

int vtkRibbonFilter::UseDefaultNormal [protected]
 

Definition at line 131 of file vtkRibbonFilter.h.


The documentation for this class was generated from the following file:
Generated on Thu Mar 28 14:41:56 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001