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

#include <vtkRibbonFilter.h>

Inheritance diagram for vtkRibbonFilter:

Collaboration diagram for vtkRibbonFilter:

Public Types
typedef vtkPolyDataAlgorithm	Superclass

Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkRibbonFilter *	NewInstance () 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 ()

Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm *	NewInstance () const

vtkDataObject *	GetInput ()

vtkDataObject *	GetInput (int port)

vtkPolyData *	GetPolyDataInput (int port)

vtkPolyData *	GetOutput ()

vtkPolyData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkRibbonFilter *	SafeDownCast (vtkObjectBase *o)

static vtkRibbonFilter *	New ()

Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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 Member Functions inherited from vtkPolyDataAlgorithm
	vtkPolyDataAlgorithm ()

	~vtkPolyDataAlgorithm ()

virtual int	RequestInformation (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Width

double	Angle

int	VaryWidth

double	WidthFactor

double	DefaultNormal [3]

int	UseDefaultNormal

int	GenerateTCoords

double	TextureLength

double	Theta

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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 * name )

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

static vtkRibbonFilter* vtkRibbonFilter::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkRibbonFilter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

vtkRibbonFilter* vtkRibbonFilter::NewInstance ( ) const

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.

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