vtkGenericGlyph3DFilter Class Reference

copy oriented and scaled glyph geometry to every input point More...

#include <vtkGenericGlyph3DFilter.h>

Inheritance diagram for vtkGenericGlyph3DFilter:

Collaboration diagram for vtkGenericGlyph3DFilter:

Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...
vtkGenericGlyph3DFilter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...
void	SetSourceData (vtkPolyData *pd)
	Set the source to use for the glyph. More...
void	SetSourceData (int id, vtkPolyData *pd)
	Specify a source object at a specified table location. More...
vtkPolyData *	GetSource (int id=0)
	Get a pointer to a source object at a specified table location. More...
virtual void	SetScaling (vtkTypeBool)
	Turn on/off scaling of source geometry. More...
virtual void	ScalingOn ()
virtual void	ScalingOff ()
virtual vtkTypeBool	GetScaling ()
virtual void	SetScaleMode (int)
	Either scale by scalar or by vector/normal magnitude. More...
virtual int	GetScaleMode ()
void	SetScaleModeToScaleByScalar ()
void	SetScaleModeToScaleByVector ()
void	SetScaleModeToScaleByVectorComponents ()
void	SetScaleModeToDataScalingOff ()
const char *	GetScaleModeAsString ()
	Return the method of scaling as a descriptive character string. More...
virtual void	SetColorMode (int)
	Either color by scale, scalar or by vector/normal magnitude. More...
virtual int	GetColorMode ()
void	SetColorModeToColorByScale ()
void	SetColorModeToColorByScalar ()
void	SetColorModeToColorByVector ()
const char *	GetColorModeAsString ()
	Return the method of coloring as a descriptive character string. More...
virtual void	SetScaleFactor (double)
	Specify scale factor to scale object by. More...
virtual double	GetScaleFactor ()
virtual void	SetRange (double, double)
	Specify range to map scalar values into. More...
void	SetRange (double[2])
virtual double *	GetRange ()
virtual void	GetRange (double data[2])
virtual void	SetOrient (vtkTypeBool)
	Turn on/off orienting of input geometry along vector/normal. More...
virtual void	OrientOn ()
virtual void	OrientOff ()
virtual vtkTypeBool	GetOrient ()
virtual void	SetClamping (vtkTypeBool)
	Turn on/off clamping of "scalar" values to range. More...
virtual void	ClampingOn ()
virtual void	ClampingOff ()
virtual vtkTypeBool	GetClamping ()
virtual void	SetVectorMode (int)
	Specify whether to use vector or normal to perform vector operations. More...
virtual int	GetVectorMode ()
void	SetVectorModeToUseVector ()
void	SetVectorModeToUseNormal ()
void	SetVectorModeToVectorRotationOff ()
const char *	GetVectorModeAsString ()
	Return the vector mode as a character string. More...
virtual void	SetIndexMode (int)
	Index into table of sources by scalar, by vector/normal magnitude, or no indexing. More...
virtual int	GetIndexMode ()
void	SetIndexModeToScalar ()
void	SetIndexModeToVector ()
void	SetIndexModeToOff ()
const char *	GetIndexModeAsString ()
	Return the index mode as a character string. More...
virtual void	SetGeneratePointIds (vtkTypeBool)
	Enable/disable the generation of point ids as part of the output. More...
virtual vtkTypeBool	GetGeneratePointIds ()
virtual void	GeneratePointIdsOn ()
virtual void	GeneratePointIdsOff ()
virtual void	SetPointIdsName (const char *)
	Set/Get the name of the PointIds array if generated. More...
virtual char *	GetPointIdsName ()
virtual char *	GetInputScalarsSelection ()
	If you want to use an arbitrary scalars array, then set its name here. More...
void	SelectInputScalars (const char *fieldName)
virtual char *	GetInputVectorsSelection ()
	If you want to use an arbitrary vectors array, then set its name here. More...
void	SelectInputVectors (const char *fieldName)
virtual char *	GetInputNormalsSelection ()
	If you want to use an arbitrary normals array, then set its name here. More...
void	SelectInputNormals (const char *fieldName)
Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm *	NewInstance () const
vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm. More...
vtkPolyData *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
vtkTypeBool	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	see vtkAlgorithm for details More...
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
vtkPolyData *	GetPolyDataInput (int port)
void	SetInputData (vtkDataObject *)
	Assign a data object as input. More...
void	SetInputData (int, vtkDataObject *)
void	AddInputData (vtkDataObject *)
	Assign a data object as input. More...
void	AddInputData (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...
vtkTypeBool	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped. More...
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port. More...
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm. More...
virtual void	SetInformation (vtkInformation *)
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm. More...
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm. More...
void	Register (vtkObjectBase *o) override
	Participate in garbage collection. More...
void	UnRegister (vtkObjectBase *o) override
	Decrease the reference count (release by another object). More...
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object. More...
virtual vtkTypeBool	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual double	GetProgress ()
	Get the execution progress of a process object. More...
void	SetProgress (double)
	SetProgress is deprecated. More...
void	UpdateProgress (double amount)
	Update the progress of the process object. More...
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
virtual double	GetProgressShift ()
virtual double	GetProgressScale ()
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state. More...
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file. More...
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process. More...
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)
	String based versions of SetInputArrayToProcess(). More...
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...
void	RemoveAllInputs ()
	Remove all the input data. More...
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection. More...
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index. More...
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index. More...
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index. More...
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx. More...
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections. More...
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index. More...
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port. More...
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port. More...
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm. More...
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...
virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date. More...
virtual void	Update ()
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port. More...
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...
virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port. More...
virtual int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port. More...
virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date. More...
virtual void	UpdateDataObject ()
	Create output object(s). More...
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream. More...
virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date. More...
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports. More...
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents. More...
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 ()
	These functions return the update extent for output ports that use piece extents. More...
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on. More...
virtual void	DebugOff ()
	Turn debugging output off. More...
bool	GetDebug ()
	Get the value of the debug flag. More...
void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...
virtual void	Modified ()
	Update the modification time for this object. More...
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
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 *)
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
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)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...
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
	Return the class name as a string. More...
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
virtual void	Delete ()
	Delete a VTK object. More...
virtual void	FastDelete ()
	Delete a reference to this object. More...
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream. More...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()
	Return the current reference count of this object. More...
void	SetReferenceCount (int)
	Sets the reference count. More...
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)
static vtkGenericGlyph3DFilter *	SafeDownCast (vtkObjectBase *o)
static vtkGenericGlyph3DFilter *	New ()
	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. More...
Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...
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 ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkGenericGlyph3DFilter ()
	~vtkGenericGlyph3DFilter () override
int	FillInputPortInformation (int, vtkInformation *) override
	Fill the input port information objects for this algorithm. More...
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass. More...
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	This is called by the superclass. More...
virtual void	SetInputScalarsSelection (const char *)
virtual void	SetInputVectorsSelection (const char *)
virtual void	SetInputNormalsSelection (const char *)
Protected Member Functions inherited from vtkPolyDataAlgorithm
	vtkPolyDataAlgorithm ()
	~vtkPolyDataAlgorithm () override
int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm. More...
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm () override
virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm. More...
virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm. More...
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
	Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
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)
	Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
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)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive. More...
virtual void	SetErrorCode (unsigned long)
	The error code contains a possible error that occurred while reading or writing the file. More...
void	ReportReferences (vtkGarbageCollector *) override
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
	Replace the Nth connection on the given input port. More...
virtual void	SetNumberOfInputConnections (int port, int n)
	Set the number of input connections on the given input port. More...
void	SetInputDataInternal (int port, vtkDataObject *input)
	These methods are used by subclasses to implement methods to set data objects directly as input. More...
void	AddInputDataInternal (int port, vtkDataObject *input)
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPolyData **	Source
vtkTypeBool	Scaling
int	ScaleMode
int	ColorMode
double	ScaleFactor
double	Range [2]
vtkTypeBool	Orient
int	VectorMode
vtkTypeBool	Clamping
int	IndexMode
vtkTypeBool	GeneratePointIds
char *	PointIdsName
char *	InputScalarsSelection
char *	InputVectorsSelection
char *	InputNormalsSelection
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
unsigned long	ErrorCode
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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

Definition at line 102 of file vtkGenericGlyph3DFilter.h.

Member Typedef Documentation

Superclass

typedef vtkPolyDataAlgorithm vtkGenericGlyph3DFilter::Superclass

Definition at line 105 of file vtkGenericGlyph3DFilter.h.

Constructor & Destructor Documentation

vtkGenericGlyph3DFilter()

vtkGenericGlyph3DFilter::vtkGenericGlyph3DFilter ( )

protected

~vtkGenericGlyph3DFilter()

vtkGenericGlyph3DFilter::~vtkGenericGlyph3DFilter ( )

overrideprotected

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkGenericGlyph3DFilter::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool 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.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase* vtkGenericGlyph3DFilter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

NewInstance()

vtkGenericGlyph3DFilter* vtkGenericGlyph3DFilter::NewInstance

(

)

const

PrintSelf()

void vtkGenericGlyph3DFilter::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

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.

New()

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.

SetSourceData() [1/2]

void vtkGenericGlyph3DFilter::SetSourceData ( vtkPolyData *  pd )

inline

Set the source to use for the glyph.

Definition at line 119 of file vtkGenericGlyph3DFilter.h.

SetSourceData() [2/2]

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

Specify a source object at a specified table location.

GetSource()

vtkPolyData* vtkGenericGlyph3DFilter::GetSource

(

int

id = 0

)

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

SetScaling()

virtual void vtkGenericGlyph3DFilter::SetScaling ( vtkTypeBool  )

virtual

Turn on/off scaling of source geometry.

ScalingOn()

virtual void vtkGenericGlyph3DFilter::ScalingOn ( )

virtual

ScalingOff()

virtual void vtkGenericGlyph3DFilter::ScalingOff ( )

virtual

GetScaling()

virtual vtkTypeBool vtkGenericGlyph3DFilter::GetScaling ( )

virtual

SetScaleMode()

virtual void vtkGenericGlyph3DFilter::SetScaleMode ( int  )

virtual

Either scale by scalar or by vector/normal magnitude.

GetScaleMode()

virtual int vtkGenericGlyph3DFilter::GetScaleMode ( )

virtual

SetScaleModeToScaleByScalar()

void vtkGenericGlyph3DFilter::SetScaleModeToScaleByScalar ( )

inline

Definition at line 146 of file vtkGenericGlyph3DFilter.h.

SetScaleModeToScaleByVector()

void vtkGenericGlyph3DFilter::SetScaleModeToScaleByVector ( )

inline

Definition at line 147 of file vtkGenericGlyph3DFilter.h.

SetScaleModeToScaleByVectorComponents()

void vtkGenericGlyph3DFilter::SetScaleModeToScaleByVectorComponents ( )

inline

Definition at line 148 of file vtkGenericGlyph3DFilter.h.

SetScaleModeToDataScalingOff()

void vtkGenericGlyph3DFilter::SetScaleModeToDataScalingOff ( )

inline

Definition at line 152 of file vtkGenericGlyph3DFilter.h.

GetScaleModeAsString()

const char * vtkGenericGlyph3DFilter::GetScaleModeAsString ( void  )

inline

Return the method of scaling as a descriptive character string.

Definition at line 315 of file vtkGenericGlyph3DFilter.h.

SetColorMode()

virtual void vtkGenericGlyph3DFilter::SetColorMode ( int  )

virtual

Either color by scale, scalar or by vector/normal magnitude.

GetColorMode()

virtual int vtkGenericGlyph3DFilter::GetColorMode ( )

virtual

SetColorModeToColorByScale()

void vtkGenericGlyph3DFilter::SetColorModeToColorByScale ( )

inline

Definition at line 162 of file vtkGenericGlyph3DFilter.h.

SetColorModeToColorByScalar()

void vtkGenericGlyph3DFilter::SetColorModeToColorByScalar ( )

inline

Definition at line 163 of file vtkGenericGlyph3DFilter.h.

SetColorModeToColorByVector()

void vtkGenericGlyph3DFilter::SetColorModeToColorByVector ( )

inline

Definition at line 164 of file vtkGenericGlyph3DFilter.h.

GetColorModeAsString()

const char * vtkGenericGlyph3DFilter::GetColorModeAsString ( void  )

inline

Return the method of coloring as a descriptive character string.

Definition at line 336 of file vtkGenericGlyph3DFilter.h.

SetScaleFactor()

virtual void vtkGenericGlyph3DFilter::SetScaleFactor ( double  )

virtual

Specify scale factor to scale object by.

GetScaleFactor()

virtual double vtkGenericGlyph3DFilter::GetScaleFactor ( )

virtual

SetRange() [1/2]

virtual void vtkGenericGlyph3DFilter::SetRange ( double  , double    )

virtual

Specify range to map scalar values into.

SetRange() [2/2]

void vtkGenericGlyph3DFilter::SetRange

(

double

[2]

)

GetRange() [1/2]

virtual double* vtkGenericGlyph3DFilter::GetRange ( )

virtual

GetRange() [2/2]

virtual void vtkGenericGlyph3DFilter::GetRange ( double  data[2] )

virtual

SetOrient()

virtual void vtkGenericGlyph3DFilter::SetOrient ( vtkTypeBool  )

virtual

Turn on/off orienting of input geometry along vector/normal.

OrientOn()

virtual void vtkGenericGlyph3DFilter::OrientOn ( )

virtual

OrientOff()

virtual void vtkGenericGlyph3DFilter::OrientOff ( )

virtual

GetOrient()

virtual vtkTypeBool vtkGenericGlyph3DFilter::GetOrient ( )

virtual

SetClamping()

virtual void vtkGenericGlyph3DFilter::SetClamping ( vtkTypeBool  )

virtual

Turn on/off clamping of "scalar" values to range.

(Scalar value may be vector magnitude if ScaleByVector() is enabled.)

ClampingOn()

virtual void vtkGenericGlyph3DFilter::ClampingOn ( )

virtual

ClampingOff()

virtual void vtkGenericGlyph3DFilter::ClampingOff ( )

virtual

GetClamping()

virtual vtkTypeBool vtkGenericGlyph3DFilter::GetClamping ( )

virtual

SetVectorMode()

virtual void vtkGenericGlyph3DFilter::SetVectorMode ( int  )

virtual

Specify whether to use vector or normal to perform vector operations.

GetVectorMode()

virtual int vtkGenericGlyph3DFilter::GetVectorMode ( )

virtual

SetVectorModeToUseVector()

void vtkGenericGlyph3DFilter::SetVectorModeToUseVector ( )

inline

Definition at line 209 of file vtkGenericGlyph3DFilter.h.

SetVectorModeToUseNormal()

void vtkGenericGlyph3DFilter::SetVectorModeToUseNormal ( )

inline

Definition at line 210 of file vtkGenericGlyph3DFilter.h.

SetVectorModeToVectorRotationOff()

void vtkGenericGlyph3DFilter::SetVectorModeToVectorRotationOff ( )

inline

Definition at line 211 of file vtkGenericGlyph3DFilter.h.

GetVectorModeAsString()

const char * vtkGenericGlyph3DFilter::GetVectorModeAsString ( void  )

inline

Return the vector mode as a character string.

Definition at line 357 of file vtkGenericGlyph3DFilter.h.

SetIndexMode()

virtual void vtkGenericGlyph3DFilter::SetIndexMode ( int  )

virtual

Index into table of sources by scalar, by vector/normal magnitude, or no indexing.

If indexing is turned off, then the first source glyph in the table of glyphs is used.

GetIndexMode()

virtual int vtkGenericGlyph3DFilter::GetIndexMode ( )

virtual

SetIndexModeToScalar()

void vtkGenericGlyph3DFilter::SetIndexModeToScalar ( )

inline

Definition at line 223 of file vtkGenericGlyph3DFilter.h.

SetIndexModeToVector()

void vtkGenericGlyph3DFilter::SetIndexModeToVector ( )

inline

Definition at line 224 of file vtkGenericGlyph3DFilter.h.

SetIndexModeToOff()

void vtkGenericGlyph3DFilter::SetIndexModeToOff ( )

inline

Definition at line 225 of file vtkGenericGlyph3DFilter.h.

GetIndexModeAsString()

const char * vtkGenericGlyph3DFilter::GetIndexModeAsString ( void  )

inline

Return the index mode as a character string.

Definition at line 378 of file vtkGenericGlyph3DFilter.h.

SetGeneratePointIds()

virtual void vtkGenericGlyph3DFilter::SetGeneratePointIds ( vtkTypeBool  )

virtual

Enable/disable the generation of point ids as part of the output.

The point ids are the id of the input generating point. The point ids are stored in the output point field data and named "InputPointIds". Point generation is useful for debugging and pick operations.

GetGeneratePointIds()

virtual vtkTypeBool vtkGenericGlyph3DFilter::GetGeneratePointIds ( )

virtual

GeneratePointIdsOn()

virtual void vtkGenericGlyph3DFilter::GeneratePointIdsOn ( )

virtual

GeneratePointIdsOff()

virtual void vtkGenericGlyph3DFilter::GeneratePointIdsOff ( )

virtual

SetPointIdsName()

virtual void vtkGenericGlyph3DFilter::SetPointIdsName ( const char *  )

virtual

Set/Get the name of the PointIds array if generated.

By default the Ids are named "InputPointIds", but this can be changed with this function.

GetPointIdsName()

virtual char* vtkGenericGlyph3DFilter::GetPointIdsName ( )

virtual

GetInputScalarsSelection()

virtual char* vtkGenericGlyph3DFilter::GetInputScalarsSelection ( )

virtual

If you want to use an arbitrary scalars array, then set its name here.

By default this in nullptr and the filter will use the active scalar array.

SelectInputScalars()

void vtkGenericGlyph3DFilter::SelectInputScalars ( const char *  fieldName )

inline

Definition at line 256 of file vtkGenericGlyph3DFilter.h.

GetInputVectorsSelection()

virtual char* vtkGenericGlyph3DFilter::GetInputVectorsSelection ( )

virtual

If you want to use an arbitrary vectors array, then set its name here.

By default this in nullptr and the filter will use the active vector array.

SelectInputVectors()

void vtkGenericGlyph3DFilter::SelectInputVectors ( const char *  fieldName )

inline

Definition at line 265 of file vtkGenericGlyph3DFilter.h.

GetInputNormalsSelection()

virtual char* vtkGenericGlyph3DFilter::GetInputNormalsSelection ( )

virtual

If you want to use an arbitrary normals array, then set its name here.

By default this in nullptr and the filter will use the active normal array.

SelectInputNormals()

void vtkGenericGlyph3DFilter::SelectInputNormals ( const char *  fieldName )

inline

Definition at line 274 of file vtkGenericGlyph3DFilter.h.

FillInputPortInformation()

int vtkGenericGlyph3DFilter::FillInputPortInformation ( int  port, vtkInformation *  info  )

overrideprotectedvirtual

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPolyDataAlgorithm.

RequestData()

int vtkGenericGlyph3DFilter::RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

RequestInformation()

int vtkGenericGlyph3DFilter::RequestInformation ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

overrideprotectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

RequestUpdateExtent()

int vtkGenericGlyph3DFilter::RequestUpdateExtent ( vtkInformation *  , vtkInformationVector **  , vtkInformationVector *    )

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

SetInputScalarsSelection()

virtual void vtkGenericGlyph3DFilter::SetInputScalarsSelection ( const char *  )

protectedvirtual

SetInputVectorsSelection()

virtual void vtkGenericGlyph3DFilter::SetInputVectorsSelection ( const char *  )

protectedvirtual

SetInputNormalsSelection()

virtual void vtkGenericGlyph3DFilter::SetInputNormalsSelection ( const char *  )

protectedvirtual

Member Data Documentation

Source

vtkPolyData** vtkGenericGlyph3DFilter::Source

protected

Definition at line 286 of file vtkGenericGlyph3DFilter.h.

Scaling

vtkTypeBool vtkGenericGlyph3DFilter::Scaling

protected

Definition at line 287 of file vtkGenericGlyph3DFilter.h.

ScaleMode

int vtkGenericGlyph3DFilter::ScaleMode

protected

Definition at line 288 of file vtkGenericGlyph3DFilter.h.

ColorMode

int vtkGenericGlyph3DFilter::ColorMode

protected

Definition at line 289 of file vtkGenericGlyph3DFilter.h.

ScaleFactor

double vtkGenericGlyph3DFilter::ScaleFactor

protected

Definition at line 290 of file vtkGenericGlyph3DFilter.h.

Range

double vtkGenericGlyph3DFilter::Range[2]

protected

Definition at line 291 of file vtkGenericGlyph3DFilter.h.

Orient

vtkTypeBool vtkGenericGlyph3DFilter::Orient

protected

Definition at line 292 of file vtkGenericGlyph3DFilter.h.

VectorMode

int vtkGenericGlyph3DFilter::VectorMode

protected

Definition at line 293 of file vtkGenericGlyph3DFilter.h.

Clamping

vtkTypeBool vtkGenericGlyph3DFilter::Clamping

protected

Definition at line 294 of file vtkGenericGlyph3DFilter.h.

IndexMode

int vtkGenericGlyph3DFilter::IndexMode

protected

Definition at line 295 of file vtkGenericGlyph3DFilter.h.

GeneratePointIds

vtkTypeBool vtkGenericGlyph3DFilter::GeneratePointIds

protected

Definition at line 296 of file vtkGenericGlyph3DFilter.h.

PointIdsName

char* vtkGenericGlyph3DFilter::PointIdsName

protected

Definition at line 297 of file vtkGenericGlyph3DFilter.h.

InputScalarsSelection

char* vtkGenericGlyph3DFilter::InputScalarsSelection

protected

Definition at line 299 of file vtkGenericGlyph3DFilter.h.

InputVectorsSelection

char* vtkGenericGlyph3DFilter::InputVectorsSelection

protected

Definition at line 300 of file vtkGenericGlyph3DFilter.h.

InputNormalsSelection

char* vtkGenericGlyph3DFilter::InputNormalsSelection

protected

Definition at line 301 of file vtkGenericGlyph3DFilter.h.

---

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

• Filters/Generic/vtkGenericGlyph3DFilter.h