vtkGenericGlyph3DFilter Class Reference
#include <vtkGenericGlyph3DFilter.h>
Inheritance diagram for vtkGenericGlyph3DFilter:
[legend]Collaboration diagram for vtkGenericGlyph3DFilter:
[legend]List of all members.
Detailed Description
copy oriented and scaled glyph geometry to every input point
vtkGenericGlyph3DFilter is a filter that copies a geometric representation (called a glyph) to every point in the input dataset. The glyph is defined with polygonal data from a source filter input. The glyph may be oriented along the input vectors or normals, and it may be scaled according to scalar data or vector magnitude. More than one glyph may be used by creating a table of source objects, each defining a different glyph. If a table of glyphs is defined, then the table can be indexed into by using either scalar value or vector magnitude.
To use this object you'll have to provide an input dataset and a source to define the glyph. Then decide whether you want to scale the glyph and how to scale the glyph (using scalar value or vector magnitude). Next decide whether you want to orient the glyph, and whether to use the vector data or normal data to orient it. Finally, decide whether to use a table of glyphs, or just a single glyph. If you use a table of glyphs, you'll have to decide whether to index into it with scalar value or with vector magnitude.
- Warning:
- Contrary to vtkGlyph3D, the only way to specify which attributes will be used for scaling, coloring and orienting is through SelectInputScalars(), SelectInputVectors() and SelectInputNormals().
The scaling of the glyphs is controlled by the ScaleFactor ivar multiplied by the scalar value at each point (if VTK_SCALE_BY_SCALAR is set), or multiplied by the vector magnitude (if VTK_SCALE_BY_VECTOR is set), Alternatively (if VTK_SCALE_BY_VECTORCOMPONENTS is set), the scaling may be specified for x,y,z using the vector components. The scale factor can be further controlled by enabling clamping using the Clamping ivar. If clamping is enabled, the scale is normalized by the Range ivar, and then multiplied by the scale factor. The normalization process includes clamping the scale value between (0,1).
Typically this object operates on input data with scalar and/or vector data. However, scalar and/or vector aren't necessary, and it can be used to copy data from a single source to each point. In this case the scale factor can be used to uniformly scale the glyphs.
The object uses "vector" data to scale glyphs, orient glyphs, and/or index into a table of glyphs. You can choose to use either the vector or normal data at each input point. Use the method SetVectorModeToUseVector() to use the vector input data, and SetVectorModeToUseNormal() to use the normal input data.
If you do use a table of glyphs, make sure to set the Range ivar to make sure the index into the glyph table is computed correctly.
You can turn off scaling of the glyphs completely by using the Scaling ivar. You can also turn off scaling due to data (either vector or scalar) by using the SetScaleModeToDataScalingOff() method.
- See also:
- vtkTensorGlyph
- Created by:
-
- CVS contributions (if > 5%):
-
- CVS logs (CVSweb):
/GenericFiltering/vtkGenericGlyph3DFilter.cxx)/GenericFiltering/vtkGenericGlyph3DFilter.h)
- Tests:
- vtkGenericGlyph3DFilter (Tests)
Definition at line 113 of file vtkGenericGlyph3DFilter.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkGenericGlyph3DFilter::vtkGenericGlyph3DFilter |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkGenericGlyph3DFilter::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkGenericGlyph3DFilter::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkGenericDataSetToPolyDataFilter. |
| virtual int vtkGenericGlyph3DFilter::IsA |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkGenericDataSetToPolyDataFilter. |
| void vtkGenericGlyph3DFilter::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
|
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkGenericDataSetToPolyDataFilter. |
|
|
Construct object with scaling on, scaling mode is by scalar value, scale factor = 1.0, the range is (0,1), orient geometry is on, and orientation is by vector. Clamping and indexing are turned off. No initial sources are defined.
Reimplemented from vtkAlgorithm. |
| void vtkGenericGlyph3DFilter::SetNumberOfSources |
( |
int |
num |
) |
|
|
|
|
Get the number of source objects used to define the glyph table. Specify the number of sources before defining a table of glyphs. |
| int vtkGenericGlyph3DFilter::GetNumberOfSources |
( |
|
) |
|
|
|
|
Get the number of source objects used to define the glyph table. Specify the number of sources before defining a table of glyphs. |
| void vtkGenericGlyph3DFilter::SetSource |
( |
vtkPolyData * |
pd |
) |
[inline] |
|
| void vtkGenericGlyph3DFilter::SetSource |
( |
int |
id, |
|
|
vtkPolyData * |
pd |
|
) |
|
|
|
|
Specify a source object at a specified table location. |
| vtkPolyData* vtkGenericGlyph3DFilter::GetSource |
( |
int |
id = 0 |
) |
|
|
|
|
Get a pointer to a source object at a specified table location. |
| virtual void vtkGenericGlyph3DFilter::SetScaling |
( |
int |
|
) |
[virtual] |
|
|
|
Turn on/off scaling of source geometry. |
| virtual void vtkGenericGlyph3DFilter::ScalingOn |
( |
|
) |
[virtual] |
|
|
|
Turn on/off scaling of source geometry. |
| virtual void vtkGenericGlyph3DFilter::ScalingOff |
( |
|
) |
[virtual] |
|
|
|
Turn on/off scaling of source geometry. |
| virtual int vtkGenericGlyph3DFilter::GetScaling |
( |
|
) |
[virtual] |
|
|
|
Turn on/off scaling of source geometry. |
| virtual void vtkGenericGlyph3DFilter::SetScaleMode |
( |
int |
|
) |
[virtual] |
|
|
|
Either scale by scalar or by vector/normal magnitude. |
| virtual int vtkGenericGlyph3DFilter::GetScaleMode |
( |
|
) |
[virtual] |
|
|
|
Either scale by scalar or by vector/normal magnitude. |
| void vtkGenericGlyph3DFilter::SetScaleModeToScaleByScalar |
( |
|
) |
[inline] |
|
| void vtkGenericGlyph3DFilter::SetScaleModeToScaleByVector |
( |
|
) |
[inline] |
|
| void vtkGenericGlyph3DFilter::SetScaleModeToScaleByVectorComponents |
( |
|
) |
[inline] |
|
| void vtkGenericGlyph3DFilter::SetScaleModeToDataScalingOff |
( |
|
) |
[inline] |
|
| const char * vtkGenericGlyph3DFilter::GetScaleModeAsString |
( |
void |
|
) |
[inline] |
|
| virtual void vtkGenericGlyph3DFilter::SetColorMode |
( |
int |
|
) |
[virtual] |
|
|
|
Either color by scale, scalar or by vector/normal magnitude. |
| virtual int vtkGenericGlyph3DFilter::GetColorMode |
( |
|
) |
[virtual] |
|
|
|
Either color by scale, scalar or by vector/normal magnitude. |
| void vtkGenericGlyph3DFilter::SetColorModeToColorByScale |
( |
|
) |
[inline] |
|
| void vtkGenericGlyph3DFilter::SetColorModeToColorByScalar |
( |
|
) |
[inline] |
|
| void vtkGenericGlyph3DFilter::SetColorModeToColorByVector |
( |
|
) |
[inline] |
|
| const char * vtkGenericGlyph3DFilter::GetColorModeAsString |
( |
void |
|
) |
[inline] |
|
| virtual void vtkGenericGlyph3DFilter::SetScaleFactor |
( |
double |
|
) |
[virtual] |
|
|
|
Specify scale factor to scale object by. |
| virtual double vtkGenericGlyph3DFilter::GetScaleFactor |
( |
|
) |
[virtual] |
|
|
|
Specify scale factor to scale object by. |
| virtual void vtkGenericGlyph3DFilter::SetRange |
( |
double |
, |
|
|
double |
|
|
) |
[virtual] |
|
|
|
Specify range to map scalar values into. |
| void vtkGenericGlyph3DFilter::SetRange |
( |
double |
[2] |
) |
|
|
|
|
Specify range to map scalar values into. |
| virtual double* vtkGenericGlyph3DFilter::GetRange |
( |
|
) |
[virtual] |
|
|
|
Specify range to map scalar values into. |
| virtual void vtkGenericGlyph3DFilter::GetRange |
( |
double |
data[2] |
) |
[virtual] |
|
|
|
Specify range to map scalar values into. |
| virtual void vtkGenericGlyph3DFilter::SetOrient |
( |
int |
|
) |
[virtual] |
|
|
|
Turn on/off orienting of input geometry along vector/normal. |
| virtual void vtkGenericGlyph3DFilter::OrientOn |
( |
|
) |
[virtual] |
|
|
|
Turn on/off orienting of input geometry along vector/normal. |
| virtual void vtkGenericGlyph3DFilter::OrientOff |
( |
|
) |
[virtual] |
|
|
|
Turn on/off orienting of input geometry along vector/normal. |
| virtual int vtkGenericGlyph3DFilter::GetOrient |
( |
|
) |
[virtual] |
|
|
|
Turn on/off orienting of input geometry along vector/normal. |
| virtual void vtkGenericGlyph3DFilter::SetClamping |
( |
int |
|
) |
[virtual] |
|
|
|
Turn on/off clamping of "scalar" values to range. (Scalar value may be vector magnitude if ScaleByVector() is enabled.) |
| virtual void vtkGenericGlyph3DFilter::ClampingOn |
( |
|
) |
[virtual] |
|
|
|
Turn on/off clamping of "scalar" values to range. (Scalar value may be vector magnitude if ScaleByVector() is enabled.) |
| virtual void vtkGenericGlyph3DFilter::ClampingOff |
( |
|
) |
[virtual] |
|
|
|
Turn on/off clamping of "scalar" values to range. (Scalar value may be vector magnitude if ScaleByVector() is enabled.) |
| virtual int vtkGenericGlyph3DFilter::GetClamping |
( |
|
) |
[virtual] |
|
|
|
Turn on/off clamping of "scalar" values to range. (Scalar value may be vector magnitude if ScaleByVector() is enabled.) |
| virtual void vtkGenericGlyph3DFilter::SetVectorMode |
( |
int |
|
) |
[virtual] |
|
|
|
Specify whether to use vector or normal to perform vector operations. |
| virtual int vtkGenericGlyph3DFilter::GetVectorMode |
( |
|
) |
[virtual] |
|
|
|
Specify whether to use vector or normal to perform vector operations. |
| void vtkGenericGlyph3DFilter::SetVectorModeToUseVector |
( |
|
) |
[inline] |
|
| void vtkGenericGlyph3DFilter::SetVectorModeToUseNormal |
( |
|
) |
[inline] |
|
| void vtkGenericGlyph3DFilter::SetVectorModeToVectorRotationOff |
( |
|
) |
[inline] |
|
| const char * vtkGenericGlyph3DFilter::GetVectorModeAsString |
( |
void |
|
) |
[inline] |
|
| 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. |
| virtual int vtkGenericGlyph3DFilter::GetIndexMode |
( |
|
) |
[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. |
| void vtkGenericGlyph3DFilter::SetIndexModeToScalar |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 220 of file vtkGenericGlyph3DFilter.h.
References VTK_INDEXING_BY_SCALAR. |
| void vtkGenericGlyph3DFilter::SetIndexModeToVector |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 221 of file vtkGenericGlyph3DFilter.h.
References VTK_INDEXING_BY_VECTOR. |
| void vtkGenericGlyph3DFilter::SetIndexModeToOff |
( |
|
) |
[inline] |
|
|
|
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.
Definition at line 222 of file vtkGenericGlyph3DFilter.h.
References VTK_INDEXING_OFF. |
| const char * vtkGenericGlyph3DFilter::GetIndexModeAsString |
( |
void |
|
) |
[inline] |
|
| virtual void vtkGenericGlyph3DFilter::SetGeneratePointIds |
( |
int |
|
) |
[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. |
| virtual int vtkGenericGlyph3DFilter::GetGeneratePointIds |
( |
|
) |
[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. |
| virtual void vtkGenericGlyph3DFilter::GeneratePointIdsOn |
( |
|
) |
[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. |
| virtual void vtkGenericGlyph3DFilter::GeneratePointIdsOff |
( |
|
) |
[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. |
| 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. |
| virtual char* vtkGenericGlyph3DFilter::GetPointIdsName |
( |
|
) |
[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. |
| virtual char* vtkGenericGlyph3DFilter::GetInputScalarsSelection |
( |
|
) |
[virtual] |
|
|
|
If you want to use an arbitrary scalars array, then set its name here. By default this in NULL and the filter will use the active scalar array. |
| void vtkGenericGlyph3DFilter::SelectInputScalars |
( |
const char * |
fieldName |
) |
[inline] |
|
|
|
If you want to use an arbitrary scalars array, then set its name here. By default this in NULL and the filter will use the active scalar array.
Definition at line 249 of file vtkGenericGlyph3DFilter.h. |
| virtual char* vtkGenericGlyph3DFilter::GetInputVectorsSelection |
( |
|
) |
[virtual] |
|
|
|
If you want to use an arbitrary vectors array, then set its name here. By default this in NULL and the filter will use the active vector array. |
| void vtkGenericGlyph3DFilter::SelectInputVectors |
( |
const char * |
fieldName |
) |
[inline] |
|
|
|
If you want to use an arbitrary vectors array, then set its name here. By default this in NULL and the filter will use the active vector array.
Definition at line 258 of file vtkGenericGlyph3DFilter.h. |
| virtual char* vtkGenericGlyph3DFilter::GetInputNormalsSelection |
( |
|
) |
[virtual] |
|
|
|
If you want to use an arbitrary normals array, then set its name here. By default this in NULL and the filter will use the active normal array. |
| void vtkGenericGlyph3DFilter::SelectInputNormals |
( |
const char * |
fieldName |
) |
[inline] |
|
|
|
If you want to use an arbitrary normals array, then set its name here. By default this in NULL and the filter will use the active normal array.
Definition at line 267 of file vtkGenericGlyph3DFilter.h. |
| virtual int vtkGenericGlyph3DFilter::FillInputPortInformation |
( |
int |
, |
|
|
vtkInformation * |
|
|
) |
[protected, virtual] |
|
|
|
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 vtkGenericDataSetToPolyDataFilter. |
| void vtkGenericGlyph3DFilter::Execute |
( |
|
) |
[protected, virtual] |
|
|
|
This method is the old style execute method
Reimplemented from vtkSource. |
| void vtkGenericGlyph3DFilter::ExecuteInformation |
( |
|
) |
[protected, virtual] |
|
| void vtkGenericGlyph3DFilter::ComputeInputUpdateExtents |
( |
vtkDataObject * |
output |
) |
[protected, virtual] |
|
| virtual void vtkGenericGlyph3DFilter::SetInputScalarsSelection |
( |
const char * |
|
) |
[protected, virtual] |
|
| virtual void vtkGenericGlyph3DFilter::SetInputVectorsSelection |
( |
const char * |
|
) |
[protected, virtual] |
|
| virtual void vtkGenericGlyph3DFilter::SetInputNormalsSelection |
( |
const char * |
|
) |
[protected, virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file: