vtkGenericGlyph3DFilter Class Reference

#include <vtkGenericGlyph3DFilter.h>

Inheritance diagram for vtkGenericGlyph3DFilter:

[legend]

Collaboration diagram for vtkGenericGlyph3DFilter:

[legend]

List of all members.

Detailed Description

copy oriented and scaled glyph geometry to every input point

vtkGenericGlyph3DFilter is a filter that copies a geometric representation (called a glyph) to every point in the input dataset. The glyph is defined with polygonal data from a source filter input. The glyph may be oriented along the input vectors or normals, and it may be scaled according to scalar data or vector magnitude. More than one glyph may be used by creating a table of source objects, each defining a different glyph. If a table of glyphs is defined, then the table can be indexed into by using either scalar value or vector magnitude.

To use this object you'll have to provide an input dataset and a source to define the glyph. Then decide whether you want to scale the glyph and how to scale the glyph (using scalar value or vector magnitude). Next decide whether you want to orient the glyph, and whether to use the vector data or normal data to orient it. Finally, decide whether to use a table of glyphs, or just a single glyph. If you use a table of glyphs, you'll have to decide whether to index into it with scalar value or with vector magnitude.

Warning:

Contrary to vtkGlyph3D, the only way to specify which attributes will be used for scaling, coloring and orienting is through SelectInputScalars(), SelectInputVectors() and SelectInputNormals().

The scaling of the glyphs is controlled by the ScaleFactor ivar multiplied by the scalar value at each point (if VTK_SCALE_BY_SCALAR is set), or multiplied by the vector magnitude (if VTK_SCALE_BY_VECTOR is set), Alternatively (if VTK_SCALE_BY_VECTORCOMPONENTS is set), the scaling may be specified for x,y,z using the vector components. The scale factor can be further controlled by enabling clamping using the Clamping ivar. If clamping is enabled, the scale is normalized by the Range ivar, and then multiplied by the scale factor. The normalization process includes clamping the scale value between (0,1).

Typically this object operates on input data with scalar and/or vector data. However, scalar and/or vector aren't necessary, and it can be used to copy data from a single source to each point. In this case the scale factor can be used to uniformly scale the glyphs.

The object uses "vector" data to scale glyphs, orient glyphs, and/or index into a table of glyphs. You can choose to use either the vector or normal data at each input point. Use the method SetVectorModeToUseVector() to use the vector input data, and SetVectorModeToUseNormal() to use the normal input data.

If you do use a table of glyphs, make sure to set the Range ivar to make sure the index into the glyph table is computed correctly.

You can turn off scaling of the glyphs completely by using the Scaling ivar. You can also turn off scaling due to data (either vector or scalar) by using the SetScaleModeToDataScalingOff() method.

See also:: vtkTensorGlyph

Tests:: vtkGenericGlyph3DFilter (Tests)

Definition at line 103 of file vtkGenericGlyph3DFilter.h.


Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetSource (vtkPolyData *pd)
void	SetSource (int id, vtkPolyData *pd)
vtkPolyData *	GetSource (int id=0)

virtual void	SetScaling (int)
virtual void	ScalingOn ()
virtual void	ScalingOff ()
virtual int	GetScaling ()

virtual void	SetScaleMode (int)
virtual int	GetScaleMode ()
void	SetScaleModeToScaleByScalar ()
void	SetScaleModeToScaleByVector ()
void	SetScaleModeToScaleByVectorComponents ()
void	SetScaleModeToDataScalingOff ()
const char *	GetScaleModeAsString ()

virtual void	SetColorMode (int)
virtual int	GetColorMode ()
void	SetColorModeToColorByScale ()
void	SetColorModeToColorByScalar ()
void	SetColorModeToColorByVector ()
const char *	GetColorModeAsString ()

virtual void	SetScaleFactor (double)
virtual double	GetScaleFactor ()

virtual void	SetRange (double, double)
void	SetRange (double[2])
virtual double *	GetRange ()
virtual void	GetRange (double data[2])

virtual void	SetOrient (int)
virtual void	OrientOn ()
virtual void	OrientOff ()
virtual int	GetOrient ()

virtual void	SetClamping (int)
virtual void	ClampingOn ()
virtual void	ClampingOff ()
virtual int	GetClamping ()

virtual void	SetVectorMode (int)
virtual int	GetVectorMode ()
void	SetVectorModeToUseVector ()
void	SetVectorModeToUseNormal ()
void	SetVectorModeToVectorRotationOff ()
const char *	GetVectorModeAsString ()

virtual void	SetIndexMode (int)
virtual int	GetIndexMode ()
void	SetIndexModeToScalar ()
void	SetIndexModeToVector ()
void	SetIndexModeToOff ()
const char *	GetIndexModeAsString ()

virtual void	SetGeneratePointIds (int)
virtual int	GetGeneratePointIds ()
virtual void	GeneratePointIdsOn ()
virtual void	GeneratePointIdsOff ()

virtual void	SetPointIdsName (const char *)
virtual char *	GetPointIdsName ()

virtual char *	GetInputScalarsSelection ()
void	SelectInputScalars (const char *fieldName)

virtual char *	GetInputVectorsSelection ()
void	SelectInputVectors (const char *fieldName)

virtual char *	GetInputNormalsSelection ()
void	SelectInputNormals (const char *fieldName)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkGenericGlyph3DFilter *	SafeDownCast (vtkObject *o)
static vtkGenericGlyph3DFilter *	New ()
Protected Member Functions
	vtkGenericGlyph3DFilter ()
	~vtkGenericGlyph3DFilter ()
int	FillInputPortInformation (int, vtkInformation *)
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual void	SetInputScalarsSelection (const char *)
virtual void	SetInputVectorsSelection (const char *)
virtual void	SetInputNormalsSelection (const char *)
Protected Attributes
vtkPolyData **	Source
int	Scaling
int	ScaleMode
int	ColorMode
double	ScaleFactor
double	Range [2]
int	Orient
int	VectorMode
int	Clamping
int	IndexMode
int	GeneratePointIds
char *	PointIdsName
char *	InputScalarsSelection
char *	InputVectorsSelection
char *	InputNormalsSelection

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkGenericGlyph3DFilter::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 106 of file vtkGenericGlyph3DFilter.h.

Constructor & Destructor Documentation

vtkGenericGlyph3DFilter::vtkGenericGlyph3DFilter ( ) [protected]

vtkGenericGlyph3DFilter::~vtkGenericGlyph3DFilter ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkPolyDataAlgorithm.

static int vtkGenericGlyph3DFilter::IsTypeOf ( const char * name ) [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 vtkPolyDataAlgorithm.

virtual int vtkGenericGlyph3DFilter::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 vtkGenericGlyph3DFilter* vtkGenericGlyph3DFilter::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

void vtkGenericGlyph3DFilter::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 vtkGenericGlyph3DFilter* vtkGenericGlyph3DFilter::New ( ) [static]

Construct object with scaling on, scaling mode is by scalar value, scale factor = 1.0, the range is (0,1), orient geometry is on, and orientation is by vector. Clamping and indexing are turned off. No initial sources are defined.

Reimplemented from vtkPolyDataAlgorithm.

void vtkGenericGlyph3DFilter::SetSource ( vtkPolyData * pd ) [inline]

Set the source to use for the glyph.

Definition at line 116 of file vtkGenericGlyph3DFilter.h.

void vtkGenericGlyph3DFilter::SetSource	(	int	id,
		vtkPolyData *	pd
	)

Specify a source object at a specified table location.

vtkPolyData* vtkGenericGlyph3DFilter::GetSource ( int id = 0 )

Get a pointer to a source object at a specified table location.

virtual void vtkGenericGlyph3DFilter::SetScaling ( int ) [virtual]

Turn on/off scaling of source geometry.

virtual void vtkGenericGlyph3DFilter::ScalingOn ( ) [virtual]

Turn on/off scaling of source geometry.

virtual void vtkGenericGlyph3DFilter::ScalingOff ( ) [virtual]

Turn on/off scaling of source geometry.

virtual int vtkGenericGlyph3DFilter::GetScaling ( ) [virtual]

Turn on/off scaling of source geometry.

virtual void vtkGenericGlyph3DFilter::SetScaleMode ( int ) [virtual]