Display a vtkDataSet with flexibility. More...

#include <vtkScatterPlotMapper.h>

Inheritance diagram for vtkScatterPlotMapper:

Collaboration diagram for vtkScatterPlotMapper:

Public Types
enum	ArrayIndex { X_COORDS = 0, Y_COORDS, Z_COORDS, COLOR, GLYPH_X_SCALE, GLYPH_Y_SCALE, GLYPH_Z_SCALE, GLYPH_SOURCE, GLYPH_X_ORIENTATION, GLYPH_Y_ORIENTATION, GLYPH_Z_ORIENTATION, NUMBER_OF_ARRAYS }
enum	ScalingArrayModes { Xc_Yc_Zc = 0, Xc0_Xc1_Xc2 = 1, Xc_Xc_Xc = 2 }
enum	ScaleModes { SCALE_BY_MAGNITUDE = 0, SCALE_BY_COMPONENTS = 1 }
enum	OrientationModes { DIRECTION = 0, ROTATION = 1 }

enum	GlyphDrawingMode { NoGlyph = 0, UseGlyph = 1, ScaledGlyph = 2, UseMultiGlyph = 4, OrientedGlyph = 8 }
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetArrayByPointCoord (ArrayIndex idx, int component=0, int connection=0)
void	SetArrayByName (ArrayIndex idx, const char *arrayName)
void	SetXCoordsArray (const char *arrayName)
void	SetYCoordsArray (const char *arrayName)
void	SetZCoordsArray (const char *arrayName)
void	SetColorArray (const char *arrayName)
void	SetGlyphXScalingArray (const char *arrayName)
void	SetGlyphYScalingArray (const char *arrayName)
void	SetGlyphZScalingArray (const char *arrayName)
void	SetGlyphSourceArray (const char *arrayName)
void	SetGlyphXOrientationArray (const char *arrayName)
void	SetGlyphYOrientationArray (const char *arrayName)
void	SetGlyphZOrientationArray (const char *arrayName)
vtkDataArray *	GetArray (ArrayIndex idx)
vtkDataArray *	GetArray (ArrayIndex idx, vtkDataSet *input)
virtual void	SetOrientationMode (int)
virtual int	GetOrientationMode ()
virtual void	Render (vtkRenderer renderer, vtkActor actor)

void	SetArrayByFieldName (ArrayIndex idx, const char *arrayName, int fieldAssociation, int component=0, int connection=0)
void	SetArrayByFieldIndex (ArrayIndex idx, int fiedIndex, int fieldAssociation, int component=0, int connection=0)

void	SetArrayByFieldType (ArrayIndex idx, int fieldAttributeType, int fieldAssociation, int component=0, int connection=0)

virtual void	SetThreeDMode (bool)
virtual bool	GetThreeDMode ()
virtual void	ThreeDModeOn ()
virtual void	ThreeDModeOff ()

virtual void	SetColorize (bool)
virtual bool	GetColorize ()
virtual void	ColorizeOn ()
virtual void	ColorizeOff ()

virtual void	SetGlyphMode (int)
virtual int	GetGlyphMode ()

virtual void	SetScalingArrayMode (int)
virtual int	GetScalingArrayMode ()

virtual void	SetScaleMode (int)
virtual int	GetScaleMode ()

virtual void	SetScaleFactor (double)
virtual double	GetScaleFactor ()

virtual void	SetNestedDisplayLists (bool)
virtual bool	GetNestedDisplayLists ()
virtual void	NestedDisplayListsOn ()
virtual void	NestedDisplayListsOff ()

virtual void	SetParallelToCamera (bool)
virtual bool	GetParallelToCamera ()
virtual void	ParallelToCameraOn ()
virtual void	ParallelToCameraOff ()

void	SetGlyphSourceConnection (int id, vtkAlgorithmOutput *algOutput)
void	SetGlyphSourceConnection (vtkAlgorithmOutput *algOutput)

void	AddGlyphSourceConnection (vtkAlgorithmOutput *algOutput)
vtkPolyData *	GetGlyphSource (int id=0)
Static Public Member Functions
static vtkScatterPlotMapper *	New ()
static int	IsTypeOf (const char *type)
static vtkScatterPlotMapper *	SafeDownCast (vtkObject *o)
static vtkInformationIntegerKey *	FIELD_ACTIVE_COMPONENT ()
Protected Member Functions
	vtkScatterPlotMapper ()
virtual	~vtkScatterPlotMapper ()
virtual void	ReportReferences (vtkGarbageCollector *collector)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
void	CopyInformationToSubMapper (vtkPainterPolyDataMapper *mapper)
virtual void	PrepareForRendering (vtkRenderer renderer, vtkActor actor)
void	InitGlyphMappers (vtkRenderer renderer, vtkActor actor, bool createDisplayList=true)
void	GenerateDefaultGlyphs ()
virtual void	ComputeBounds ()
virtual void	UpdatePainterInformation ()
vtkScatterPlotPainter *	GetScatterPlotPainter ()
Protected Attributes
bool	ThreeDMode
bool	Colorize
int	GlyphMode
double	ScaleFactor
int	ScaleMode
int	ScalingArrayMode
int	OrientationMode
bool	NestedDisplayLists
bool	ParallelToCamera

Detailed Description

Display a vtkDataSet with flexibility.

The mappers gives flexibility in the display of the input. By setting the arrays to process, every element of the display can be controlled. i.e. the coordinates of the points can be controlled by any field array or the color of the points can controlled by the x-axes.

See also:: vtkGlyph3D, vtkCompositePolyDataMapper2

The mappers gives flexibility in the display of the input. By setting the arrays to process, every element of the display can be controlled. i.e. the coordinates of the points can be controlled by any field array or the color of the points can controlled by the x-axes.

See also:: vtkGlyph3D

Definition at line 38 of file vtkScatterPlotMapper.h.

Member Enumeration Documentation

enum vtkScatterPlotMapper::ArrayIndex

Enumerator:

X_COORDS
Y_COORDS
Z_COORDS
COLOR
GLYPH_X_SCALE
GLYPH_Y_SCALE
GLYPH_Z_SCALE
GLYPH_SOURCE
GLYPH_X_ORIENTATION
GLYPH_Y_ORIENTATION
GLYPH_Z_ORIENTATION
NUMBER_OF_ARRAYS

Definition at line 46 of file vtkScatterPlotMapper.h.

enum vtkScatterPlotMapper::GlyphDrawingMode

Flags to control how the glyphs are displayed. To use the default glyphs, set the GlyphMode to UseGlyph. The other flags must have their corresponding array in order to be valid. GLYPH_[XYZ]_SCALE for ScaledGlyph; GLYPH_SOURCE for UseMultiGlyph and GLYPH_[XYZ]_ORIENTATION for OrientedGlyph.

Enumerator:

NoGlyph
UseGlyph
ScaledGlyph
UseMultiGlyph
OrientedGlyph

Definition at line 68 of file vtkScatterPlotMapper.h.

enum vtkScatterPlotMapper::ScalingArrayModes

Enumerator:

Xc_Yc_Zc
Xc0_Xc1_Xc2
Xc_Xc_Xc

Definition at line 78 of file vtkScatterPlotMapper.h.

enum vtkScatterPlotMapper::ScaleModes

Enumerator:

SCALE_BY_MAGNITUDE
SCALE_BY_COMPONENTS

Definition at line 91 of file vtkScatterPlotMapper.h.

enum vtkScatterPlotMapper::OrientationModes

Enumerator:

DIRECTION
ROTATION

Definition at line 97 of file vtkScatterPlotMapper.h.

Constructor & Destructor Documentation

vtkScatterPlotMapper::vtkScatterPlotMapper ( ) [protected]

virtual vtkScatterPlotMapper::~vtkScatterPlotMapper ( ) [protected, virtual]

Member Function Documentation

static vtkScatterPlotMapper* vtkScatterPlotMapper::New ( ) [static]

Reimplemented from vtkCompositePolyDataMapper2.

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

Reimplemented from vtkCompositePolyDataMapper2.

static int vtkScatterPlotMapper::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkCompositePolyDataMapper2.

virtual int vtkScatterPlotMapper::IsA ( const char * type ) [virtual]

Reimplemented from vtkCompositePolyDataMapper2.

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

Reimplemented from vtkCompositePolyDataMapper2.

void vtkScatterPlotMapper::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkCompositePolyDataMapper2.

static vtkInformationIntegerKey* vtkScatterPlotMapper::FIELD_ACTIVE_COMPONENT ( ) [static]

void vtkScatterPlotMapper::SetArrayByFieldName	(	ArrayIndex	idx,
		const char *	arrayName,
		int	fieldAssociation,
		int	component = `0`,
		int	connection = `0`
	)

Set the name of the point array to use as a mask for generating the glyphs. This is a convenience method. The same effect can be achieved by using SetInputArrayToProcess(idx, 0, connection, vtkDataObject::FIELD_ASSOCIATION_POINTS, arrayName) void SetMaskArray();

void vtkScatterPlotMapper::SetArrayByFieldIndex	(	ArrayIndex	idx,
		int	fiedIndex,
		int	fieldAssociation,
		int	component = `0`,
		int	connection = `0`
	)

Set the name of the point array to use as a mask for generating the glyphs. This is a convenience method. The same effect can be achieved by using SetInputArrayToProcess(idx, 0, connection, vtkDataObject::FIELD_ASSOCIATION_POINTS, arrayName) void SetMaskArray();

void vtkScatterPlotMapper::SetArrayByFieldType	(	ArrayIndex	idx,
		int	fieldAttributeType,
		int	fieldAssociation,
		int	component = `0`,
		int	connection = `0`
	)

Set the point attribute to use for generating the glyphs. idx is one of the following:

vtkScatterPlotMapper::X_COORDS
vtkScatterPlotMapper::Y_COORDS
vtkScatterPlotMapper::Z_COORDS
vtkScatterPlotMapper::COLOR
vtkScatterPlotMapper::GLYPH_SCALING
vtkScatterPlotMapper::GLYPH_ORIENTATION
vtkScatterPlotMapper::GLYPH_SHAPE fieldAttributeType is one of the following:
vtkDataSetAttributes::SCALARS
vtkDataSetAttributes::VECTORS
vtkDataSetAttributes::NORMALS
vtkDataSetAttributes::TCOORDS
vtkDataSetAttributes::TENSORS This is a convenience method. This internally same effect can be achieved by using SetInputArrayToProcess(idx, 0, connection, vtkDataObject::FIELD_ASSOCIATION_POINTS, fieldAttributeType)

void vtkScatterPlotMapper::SetArrayByPointCoord	(	ArrayIndex	idx,
		int	component = `0`,
		int	connection = `0`
	)

void vtkScatterPlotMapper::SetArrayByName	(	ArrayIndex	idx,
		const char *	arrayName
	)

void vtkScatterPlotMapper::SetXCoordsArray ( const char * arrayName ) [inline]

Definition at line 139 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetYCoordsArray ( const char * arrayName ) [inline]

Definition at line 141 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetZCoordsArray ( const char * arrayName ) [inline]

Definition at line 143 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetColorArray ( const char * arrayName ) [inline]

Definition at line 145 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetGlyphXScalingArray ( const char * arrayName ) [inline]

Definition at line 147 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetGlyphYScalingArray ( const char * arrayName ) [inline]

Definition at line 149 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetGlyphZScalingArray ( const char * arrayName ) [inline]

Definition at line 151 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetGlyphSourceArray ( const char * arrayName ) [inline]

Definition at line 153 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetGlyphXOrientationArray ( const char * arrayName ) [inline]

Definition at line 155 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetGlyphYOrientationArray ( const char * arrayName ) [inline]

Definition at line 157 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::SetGlyphZOrientationArray ( const char * arrayName ) [inline]

Definition at line 159 of file vtkScatterPlotMapper.h.

vtkDataArray* vtkScatterPlotMapper::GetArray ( ArrayIndex idx )

vtkDataArray* vtkScatterPlotMapper::GetArray	(	ArrayIndex	idx,
		vtkDataSet *	input
	)

virtual void vtkScatterPlotMapper::SetThreeDMode ( bool ) [virtual]

Enable or not the third (z) coordinate for 3D rendering (instead of 2D). Note: To work, the Z_Coords index array must be given.

virtual bool vtkScatterPlotMapper::GetThreeDMode ( ) [virtual]

Enable or not the third (z) coordinate for 3D rendering (instead of 2D). Note: To work, the Z_Coords index array must be given.

virtual void vtkScatterPlotMapper::ThreeDModeOn ( ) [virtual]

Enable or not the third (z) coordinate for 3D rendering (instead of 2D). Note: To work, the Z_Coords index array must be given.

virtual void vtkScatterPlotMapper::ThreeDModeOff ( ) [virtual]

Enable or not the third (z) coordinate for 3D rendering (instead of 2D). Note: To work, the Z_Coords index array must be given.

virtual void vtkScatterPlotMapper::SetColorize ( bool ) [virtual]

Enable or not the color painting at each point. Note: To work, the Color index array must be given.

virtual bool vtkScatterPlotMapper::GetColorize ( ) [virtual]

Enable or not the color painting at each point. Note: To work, the Color index array must be given.

virtual void vtkScatterPlotMapper::ColorizeOn ( ) [virtual]

Enable or not the color painting at each point. Note: To work, the Color index array must be given.

virtual void vtkScatterPlotMapper::ColorizeOff ( ) [virtual]

Enable or not the color painting at each point. Note: To work, the Color index array must be given.

virtual void vtkScatterPlotMapper::SetGlyphMode ( int ) [virtual]

Enable or not the Glyph representation at each point. Note: To work, at least 1 Glyph polydata input must be set and the Glyph index array must be given.

virtual int vtkScatterPlotMapper::GetGlyphMode ( ) [virtual]

Enable or not the Glyph representation at each point. Note: To work, at least 1 Glyph polydata input must be set and the Glyph index array must be given.

virtual void vtkScatterPlotMapper::SetScalingArrayMode ( int ) [virtual]

If the GlyphMode has ScaledGlyph turned on, ScalingArrayMode describes how to data in the different GLYPH_[X,Y,Z]_SCALE arrays

virtual int vtkScatterPlotMapper::GetScalingArrayMode ( ) [virtual]

If the GlyphMode has ScaledGlyph turned on, ScalingArrayMode describes how to data in the different GLYPH_[X,Y,Z]_SCALE arrays

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

If the GlyphMode has ScaledGlyph turned on, decide how to scale the glyph. By Magnitude or components.

virtual int vtkScatterPlotMapper::GetScaleMode ( ) [virtual]

If the GlyphMode has ScaledGlyph turned on, decide how to scale the glyph. By Magnitude or components.

virtual void vtkScatterPlotMapper::SetScaleFactor ( double ) [virtual]

Specify scale factor to scale object by. This is used only when Scaling is On.

virtual double vtkScatterPlotMapper::GetScaleFactor ( ) [virtual]

Specify scale factor to scale object by. This is used only when Scaling is On.

virtual void vtkScatterPlotMapper::SetOrientationMode ( int ) [virtual]

virtual int vtkScatterPlotMapper::GetOrientationMode ( ) [virtual]

virtual void vtkScatterPlotMapper::SetNestedDisplayLists ( bool ) [virtual]

If immediate mode is off, if Glyphs are in use and if NestedDisplayLists is false, only the mappers of each glyph use display lists. If true, in addition, matrices transforms and color per glyph are also in a parent display list. Not relevant if immediate mode is on. For debugging/profiling purpose. Initial value is true.

virtual bool vtkScatterPlotMapper::GetNestedDisplayLists ( ) [virtual]

If immediate mode is off, if Glyphs are in use and if NestedDisplayLists is false, only the mappers of each glyph use display lists. If true, in addition, matrices transforms and color per glyph are also in a parent display list. Not relevant if immediate mode is on. For debugging/profiling purpose. Initial value is true.

virtual void vtkScatterPlotMapper::NestedDisplayListsOn ( ) [virtual]

If immediate mode is off, if Glyphs are in use and if NestedDisplayLists is false, only the mappers of each glyph use display lists. If true, in addition, matrices transforms and color per glyph are also in a parent display list. Not relevant if immediate mode is on. For debugging/profiling purpose. Initial value is true.

virtual void vtkScatterPlotMapper::NestedDisplayListsOff ( ) [virtual]

If immediate mode is off, if Glyphs are in use and if NestedDisplayLists is false, only the mappers of each glyph use display lists. If true, in addition, matrices transforms and color per glyph are also in a parent display list. Not relevant if immediate mode is on. For debugging/profiling purpose. Initial value is true.

virtual void vtkScatterPlotMapper::SetParallelToCamera ( bool ) [virtual]

When the glyphs are in 2D, it might be useful to force them to be shown parallel to the camera.

virtual bool vtkScatterPlotMapper::GetParallelToCamera ( ) [virtual]

When the glyphs are in 2D, it might be useful to force them to be shown parallel to the camera.

virtual void vtkScatterPlotMapper::ParallelToCameraOn ( ) [virtual]

When the glyphs are in 2D, it might be useful to force them to be shown parallel to the camera.

virtual void vtkScatterPlotMapper::ParallelToCameraOff ( ) [virtual]

When the glyphs are in 2D, it might be useful to force them to be shown parallel to the camera.

void vtkScatterPlotMapper::SetGlyphSourceConnection	(	int	id,
		vtkAlgorithmOutput *	algOutput
	)

Specify a source object at a specified table location. New style. Source connection is stored in port 1. This method is equivalent to SetInputConnection(1, id, outputPort).

void vtkScatterPlotMapper::SetGlyphSourceConnection ( vtkAlgorithmOutput * algOutput ) [inline]

Specify a source object at a specified table location. New style. Source connection is stored in port 1. This method is equivalent to SetInputConnection(1, id, outputPort).

Definition at line 250 of file vtkScatterPlotMapper.h.

void vtkScatterPlotMapper::AddGlyphSourceConnection ( vtkAlgorithmOutput * algOutput )

Specify a source object at a specified table location. New style. Source connection is stored in port 1. This method is equivalent to SetInputConnection(1, id, outputPort).

vtkPolyData* vtkScatterPlotMapper::GetGlyphSource ( int id = 0 )

Specify a source object at a specified table location. New style. Source connection is stored in port 1. This method is equivalent to SetInputConnection(1, id, outputPort).

virtual void vtkScatterPlotMapper::Render	(	vtkRenderer *	renderer,
		vtkActor *	actor
	)		`[virtual]`

Reimplemented to allow "real" pre rendering by vtkScatterPlotPainter Indeed the vtkPainter::PrepareForRendering is not exactly a prepare for rendering (the rendering already started).

Reimplemented from vtkCompositePolyDataMapper2.

virtual void vtkScatterPlotMapper::ReportReferences ( vtkGarbageCollector * collector ) [protected, virtual]

Take part in garbage collection.

Reimplemented from vtkCompositePolyDataMapper2.