VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkGlyph3D Class Reference

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

#include <vtkGlyph3D.h>

Inheritance diagram for vtkGlyph3D:
[legend]
Collaboration diagram for vtkGlyph3D:
[legend]

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...
 
vtkGlyph3DNewInstance () 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...
 
void SetSourceConnection (int id, vtkAlgorithmOutput *algOutput)
 Specify a source object at a specified table location. More...
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 
vtkPolyDataGetSource (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 void SetFillCellData (vtkTypeBool)
 Enable/disable the generation of cell data as part of the output. More...
 
virtual vtkTypeBool GetFillCellData ()
 
virtual void FillCellDataOn ()
 
virtual void FillCellDataOff ()
 
virtual int IsPointVisible (vtkDataSet *, vtkIdType)
 This can be overwritten by subclass to return 0 when a point is blanked. More...
 
void SetSourceTransform (vtkTransform *)
 When set, this is use to transform the source polydata before using it to generate the glyph. More...
 
virtual vtkTransformGetSourceTransform ()
 
vtkMTimeType GetMTime () override
 Overridden to include SourceTransform's MTime. More...
 
virtual void SetOutputPointsPrecision (int)
 Set/get the desired precision for the output types. More...
 
virtual int GetOutputPointsPrecision ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (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
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 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...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 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...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
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...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (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 vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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)
 
vtkCommandGetCommand (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 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGlyph3DSafeDownCast (vtkObjectBase *o)
 
static vtkGlyph3DNew ()
 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 vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_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 vtkInformationIntegerKeyCAN_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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGlyph3D ()
 
 ~vtkGlyph3D () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int, vtkInformation *) override
 Fill the input port information objects for this algorithm. More...
 
vtkPolyDataGetSource (int idx, vtkInformationVector *sourceInfo)
 
virtual bool Execute (vtkDataSet *input, vtkInformationVector *sourceVector, vtkPolyData *output)
 Method called in RequestData() to do the actual data processing. More...
 
virtual bool Execute (vtkDataSet *input, vtkInformationVector *sourceVector, vtkPolyData *output, vtkDataArray *inSScalars, vtkDataArray *inVectors)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
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)
 
vtkDataArrayGetInputArrayToProcess (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...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (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...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 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 ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkPolyData ** Source
 
vtkTypeBool Scaling
 
int ScaleMode
 
int ColorMode
 
double ScaleFactor
 
double Range [2]
 
int Orient
 
int VectorMode
 
vtkTypeBool Clamping
 
int IndexMode
 
vtkTypeBool GeneratePointIds
 
vtkTypeBool FillCellData
 
char * PointIdsName
 
vtkTransformSourceTransform
 
int OutputPointsPrecision
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- 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 vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

copy oriented and scaled glyph geometry to every input point

vtkGlyph3D 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
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.
You can set what arrays to use for the scalars, vectors, normals, and color scalars by using the SetInputArrayToProcess methods in vtkAlgorithm. The first array is scalars, the next vectors, the next normals and finally color scalars.
See also
vtkTensorGlyph

Definition at line 105 of file vtkGlyph3D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 108 of file vtkGlyph3D.h.

Constructor & Destructor Documentation

◆ vtkGlyph3D()

vtkGlyph3D::vtkGlyph3D ( )
protected

◆ ~vtkGlyph3D()

vtkGlyph3D::~vtkGlyph3D ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkGlyph2D.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGlyph3D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkGlyph2D.

◆ NewInstance()

vtkGlyph3D* vtkGlyph3D::NewInstance ( ) const

◆ PrintSelf()

void vtkGlyph3D::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 vtkGlyph3D* vtkGlyph3D::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 vtkGlyph3D::SetSourceData ( vtkPolyData pd)
inline

Set the source to use for the glyph.

Note that this method does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. See SetSourceConnection for connecting the pipeline.

Definition at line 125 of file vtkGlyph3D.h.

◆ SetSourceData() [2/2]

void vtkGlyph3D::SetSourceData ( int  id,
vtkPolyData pd 
)

Specify a source object at a specified table location.

Note that this method does not connect the pipeline. The algorithm will work on the input data as it is without updating the producer of the data. See SetSourceConnection for connecting the pipeline.

◆ SetSourceConnection() [1/2]

void vtkGlyph3D::SetSourceConnection ( 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).

◆ SetSourceConnection() [2/2]

void vtkGlyph3D::SetSourceConnection ( vtkAlgorithmOutput algOutput)
inline

Definition at line 142 of file vtkGlyph3D.h.

◆ GetSource() [1/2]

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

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

◆ SetScaling()

virtual void vtkGlyph3D::SetScaling ( vtkTypeBool  )
virtual

Turn on/off scaling of source geometry.

◆ ScalingOn()

virtual void vtkGlyph3D::ScalingOn ( )
virtual

◆ ScalingOff()

virtual void vtkGlyph3D::ScalingOff ( )
virtual

◆ GetScaling()

virtual vtkTypeBool vtkGlyph3D::GetScaling ( )
virtual

◆ SetScaleMode()

virtual void vtkGlyph3D::SetScaleMode ( int  )
virtual

Either scale by scalar or by vector/normal magnitude.

◆ GetScaleMode()

virtual int vtkGlyph3D::GetScaleMode ( )
virtual

◆ SetScaleModeToScaleByScalar()

void vtkGlyph3D::SetScaleModeToScaleByScalar ( )
inline

Definition at line 168 of file vtkGlyph3D.h.

◆ SetScaleModeToScaleByVector()

void vtkGlyph3D::SetScaleModeToScaleByVector ( )
inline

Definition at line 169 of file vtkGlyph3D.h.

◆ SetScaleModeToScaleByVectorComponents()

void vtkGlyph3D::SetScaleModeToScaleByVectorComponents ( )
inline

Definition at line 170 of file vtkGlyph3D.h.

◆ SetScaleModeToDataScalingOff()

void vtkGlyph3D::SetScaleModeToDataScalingOff ( )
inline

Definition at line 174 of file vtkGlyph3D.h.

◆ GetScaleModeAsString()

const char * vtkGlyph3D::GetScaleModeAsString ( void  )
inline

Return the method of scaling as a descriptive character string.

Definition at line 362 of file vtkGlyph3D.h.

◆ SetColorMode()

virtual void vtkGlyph3D::SetColorMode ( int  )
virtual

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

◆ GetColorMode()

virtual int vtkGlyph3D::GetColorMode ( )
virtual

◆ SetColorModeToColorByScale()

void vtkGlyph3D::SetColorModeToColorByScale ( )
inline

Definition at line 184 of file vtkGlyph3D.h.

◆ SetColorModeToColorByScalar()

void vtkGlyph3D::SetColorModeToColorByScalar ( )
inline

Definition at line 185 of file vtkGlyph3D.h.

◆ SetColorModeToColorByVector()

void vtkGlyph3D::SetColorModeToColorByVector ( )
inline

Definition at line 186 of file vtkGlyph3D.h.

◆ GetColorModeAsString()

const char * vtkGlyph3D::GetColorModeAsString ( void  )
inline

Return the method of coloring as a descriptive character string.

Definition at line 383 of file vtkGlyph3D.h.

◆ SetScaleFactor()

virtual void vtkGlyph3D::SetScaleFactor ( double  )
virtual

Specify scale factor to scale object by.

◆ GetScaleFactor()

virtual double vtkGlyph3D::GetScaleFactor ( )
virtual

◆ SetRange() [1/2]

virtual void vtkGlyph3D::SetRange ( double  ,
double   
)
virtual

Specify range to map scalar values into.

◆ SetRange() [2/2]

void vtkGlyph3D::SetRange ( double  [2])

◆ GetRange() [1/2]

virtual double* vtkGlyph3D::GetRange ( )
virtual

◆ GetRange() [2/2]

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

◆ SetOrient()

virtual void vtkGlyph3D::SetOrient ( vtkTypeBool  )
virtual

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

◆ OrientOn()

virtual void vtkGlyph3D::OrientOn ( )
virtual

◆ OrientOff()

virtual void vtkGlyph3D::OrientOff ( )
virtual

◆ GetOrient()

virtual vtkTypeBool vtkGlyph3D::GetOrient ( )
virtual

◆ SetClamping()

virtual void vtkGlyph3D::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 vtkGlyph3D::ClampingOn ( )
virtual

◆ ClampingOff()

virtual void vtkGlyph3D::ClampingOff ( )
virtual

◆ GetClamping()

virtual vtkTypeBool vtkGlyph3D::GetClamping ( )
virtual

◆ SetVectorMode()

virtual void vtkGlyph3D::SetVectorMode ( int  )
virtual

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

◆ GetVectorMode()

virtual int vtkGlyph3D::GetVectorMode ( )
virtual

◆ SetVectorModeToUseVector()

void vtkGlyph3D::SetVectorModeToUseVector ( )
inline

Definition at line 231 of file vtkGlyph3D.h.

◆ SetVectorModeToUseNormal()

void vtkGlyph3D::SetVectorModeToUseNormal ( )
inline

Definition at line 232 of file vtkGlyph3D.h.

◆ SetVectorModeToVectorRotationOff()

void vtkGlyph3D::SetVectorModeToVectorRotationOff ( )
inline

Definition at line 233 of file vtkGlyph3D.h.

◆ GetVectorModeAsString()

const char * vtkGlyph3D::GetVectorModeAsString ( void  )
inline

Return the vector mode as a character string.

Definition at line 404 of file vtkGlyph3D.h.

◆ SetIndexMode()

virtual void vtkGlyph3D::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. Note that indexing mode will only use the InputScalarsSelection array and not the InputColorScalarsSelection as the scalar source if an array is specified.

◆ GetIndexMode()

virtual int vtkGlyph3D::GetIndexMode ( )
virtual

◆ SetIndexModeToScalar()

void vtkGlyph3D::SetIndexModeToScalar ( )
inline

Definition at line 247 of file vtkGlyph3D.h.

◆ SetIndexModeToVector()

void vtkGlyph3D::SetIndexModeToVector ( )
inline

Definition at line 248 of file vtkGlyph3D.h.

◆ SetIndexModeToOff()

void vtkGlyph3D::SetIndexModeToOff ( )
inline

Definition at line 249 of file vtkGlyph3D.h.

◆ GetIndexModeAsString()

const char * vtkGlyph3D::GetIndexModeAsString ( void  )
inline

Return the index mode as a character string.

Definition at line 425 of file vtkGlyph3D.h.

◆ SetGeneratePointIds()

virtual void vtkGlyph3D::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 vtkGlyph3D::GetGeneratePointIds ( )
virtual

◆ GeneratePointIdsOn()

virtual void vtkGlyph3D::GeneratePointIdsOn ( )
virtual

◆ GeneratePointIdsOff()

virtual void vtkGlyph3D::GeneratePointIdsOff ( )
virtual

◆ SetPointIdsName()

virtual void vtkGlyph3D::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* vtkGlyph3D::GetPointIdsName ( )
virtual

◆ SetFillCellData()

virtual void vtkGlyph3D::SetFillCellData ( vtkTypeBool  )
virtual

Enable/disable the generation of cell data as part of the output.

The cell data at each cell will match the point data of the input at the glyphed point.

◆ GetFillCellData()

virtual vtkTypeBool vtkGlyph3D::GetFillCellData ( )
virtual

◆ FillCellDataOn()

virtual void vtkGlyph3D::FillCellDataOn ( )
virtual

◆ FillCellDataOff()

virtual void vtkGlyph3D::FillCellDataOff ( )
virtual

◆ IsPointVisible()

virtual int vtkGlyph3D::IsPointVisible ( vtkDataSet ,
vtkIdType   
)
inlinevirtual

This can be overwritten by subclass to return 0 when a point is blanked.

Default implementation is to always return 1;

Definition at line 289 of file vtkGlyph3D.h.

◆ SetSourceTransform()

void vtkGlyph3D::SetSourceTransform ( vtkTransform )

When set, this is use to transform the source polydata before using it to generate the glyph.

This is useful if one wanted to reorient the source, for example.

◆ GetSourceTransform()

virtual vtkTransform* vtkGlyph3D::GetSourceTransform ( )
virtual

◆ GetMTime()

vtkMTimeType vtkGlyph3D::GetMTime ( )
overridevirtual

Overridden to include SourceTransform's MTime.

Reimplemented from vtkObject.

◆ SetOutputPointsPrecision()

virtual void vtkGlyph3D::SetOutputPointsPrecision ( int  )
virtual

Set/get the desired precision for the output types.

See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings.

◆ GetOutputPointsPrecision()

virtual int vtkGlyph3D::GetOutputPointsPrecision ( )
virtual

◆ RequestData()

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestUpdateExtent()

int vtkGlyph3D::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ FillInputPortInformation()

int vtkGlyph3D::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.

◆ GetSource() [2/2]

vtkPolyData* vtkGlyph3D::GetSource ( int  idx,
vtkInformationVector sourceInfo 
)
protected

◆ Execute() [1/2]

virtual bool vtkGlyph3D::Execute ( vtkDataSet input,
vtkInformationVector sourceVector,
vtkPolyData output 
)
protectedvirtual

Method called in RequestData() to do the actual data processing.

This will glyph the input, filling up the output based on the filter parameters.

◆ Execute() [2/2]

virtual bool vtkGlyph3D::Execute ( vtkDataSet input,
vtkInformationVector sourceVector,
vtkPolyData output,
vtkDataArray inSScalars,
vtkDataArray inVectors 
)
protectedvirtual

Member Data Documentation

◆ Source

vtkPolyData** vtkGlyph3D::Source
protected

Definition at line 337 of file vtkGlyph3D.h.

◆ Scaling

vtkTypeBool vtkGlyph3D::Scaling
protected

Definition at line 338 of file vtkGlyph3D.h.

◆ ScaleMode

int vtkGlyph3D::ScaleMode
protected

Definition at line 339 of file vtkGlyph3D.h.

◆ ColorMode

int vtkGlyph3D::ColorMode
protected

Definition at line 340 of file vtkGlyph3D.h.

◆ ScaleFactor

double vtkGlyph3D::ScaleFactor
protected

Definition at line 341 of file vtkGlyph3D.h.

◆ Range

double vtkGlyph3D::Range[2]
protected

Definition at line 342 of file vtkGlyph3D.h.

◆ Orient

int vtkGlyph3D::Orient
protected

Definition at line 343 of file vtkGlyph3D.h.

◆ VectorMode

int vtkGlyph3D::VectorMode
protected

Definition at line 344 of file vtkGlyph3D.h.

◆ Clamping

vtkTypeBool vtkGlyph3D::Clamping
protected

Definition at line 345 of file vtkGlyph3D.h.

◆ IndexMode

int vtkGlyph3D::IndexMode
protected

Definition at line 346 of file vtkGlyph3D.h.

◆ GeneratePointIds

vtkTypeBool vtkGlyph3D::GeneratePointIds
protected

Definition at line 347 of file vtkGlyph3D.h.

◆ FillCellData

vtkTypeBool vtkGlyph3D::FillCellData
protected

Definition at line 348 of file vtkGlyph3D.h.

◆ PointIdsName

char* vtkGlyph3D::PointIdsName
protected

Definition at line 349 of file vtkGlyph3D.h.

◆ SourceTransform

vtkTransform* vtkGlyph3D::SourceTransform
protected

Definition at line 350 of file vtkGlyph3D.h.

◆ OutputPointsPrecision

int vtkGlyph3D::OutputPointsPrecision
protected

Definition at line 351 of file vtkGlyph3D.h.


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