VTK: vtkPointGaussianMapper Class Reference

| VTK 9.3.1

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

draw PointGaussians using imposters More...

`#include <vtkPointGaussianMapper.h>`

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

## Public Types
typedef vtkPolyDataMapper | Superclass
Public Types inherited from vtkPolyDataMapper
enum | ShiftScaleMethodType { DISABLE_SHIFT_SCALE , AUTO_SHIFT_SCALE , ALWAYS_AUTO_SHIFT_SCALE , MANUAL_SHIFT_SCALE , AUTO_SHIFT , NEAR_PLANE_SHIFT_SCALE , FOCAL_POINT_SHIFT_SCALE }
| Methods for VBO coordinate shift+scale-computation. More...
typedef vtkMapper | Superclass
using | MapperHashType = std::uintptr_t
Public Types inherited from vtkMapper
typedef vtkAbstractMapper3D | Superclass
Public Types inherited from vtkAbstractMapper3D
typedef vtkAbstractMapper | Superclass
Public Types inherited from vtkAbstractMapper
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...
vtkPointGaussianMapper * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
bool | GetSupportsSelection () override
| WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...
void | SetScaleFunction (vtkPiecewiseFunction *)
| Set/Get the optional scale transfer function. More...
virtual vtkPiecewiseFunction * | GetScaleFunction ()
| Set/Get the optional scale transfer function. More...
virtual void | SetScaleTableSize (int)
| The size of the table used in computing scale, used when converting a vtkPiecewiseFunction to a table. More...
virtual int | GetScaleTableSize ()
| The size of the table used in computing scale, used when converting a vtkPiecewiseFunction to a table. More...
virtual void | SetScaleArray (const char *)
| Convenience method to set the array to scale with. More...
virtual char * | GetScaleArray ()
| Convenience method to set the array to scale with. More...
virtual void | SetScaleArrayComponent (int)
| Convenience method to set the component of the array to scale with. More...
virtual int | GetScaleArrayComponent ()
| Convenience method to set the component of the array to scale with. More...
virtual void | SetScaleFactor (double)
| Set the default scale factor of the point gaussians. More...
virtual double | GetScaleFactor ()
| Set the default scale factor of the point gaussians. More...
virtual void | SetEmissive (vtkTypeBool)
| Treat the points/splats as emissive light sources. More...
virtual vtkTypeBool | GetEmissive ()
| Treat the points/splats as emissive light sources. More...
virtual void | EmissiveOn ()
| Treat the points/splats as emissive light sources. More...
virtual void | EmissiveOff ()
| Treat the points/splats as emissive light sources. More...
void | SetScalarOpacityFunction (vtkPiecewiseFunction *)
| Set/Get the optional opacity transfer function. More...
virtual vtkPiecewiseFunction * | GetScalarOpacityFunction ()
| Set/Get the optional opacity transfer function. More...
virtual void | SetOpacityTableSize (int)
| The size of the table used in computing opacities, used when converting a vtkPiecewiseFunction to a table. More...
virtual int | GetOpacityTableSize ()
| The size of the table used in computing opacities, used when converting a vtkPiecewiseFunction to a table. More...
virtual void | SetOpacityArray (const char *)
| Method to set the optional opacity array. More...
virtual char * | GetOpacityArray ()
| Method to set the optional opacity array. More...
virtual void | SetOpacityArrayComponent (int)
| Convenience method to set the component of the array to opacify with. More...
virtual int | GetOpacityArrayComponent ()
| Convenience method to set the component of the array to opacify with. More...
virtual void | SetSplatShaderCode (const char *)
| Method to override the fragment shader code for the splat. More...
virtual char * | GetSplatShaderCode ()
| Method to override the fragment shader code for the splat. More...
virtual void | SetTriangleScale (float)
| When drawing triangles as opposed too point mode (triangles are for splats shaders that are bigger than a pixel) this controls how large the triangle will be. More...
virtual float | GetTriangleScale ()
| When drawing triangles as opposed too point mode (triangles are for splats shaders that are bigger than a pixel) this controls how large the triangle will be. More...
Public Member Functions inherited from vtkPolyDataMapper
vtkPolyDataMapper * | NewInstance () const
void | PrintSelf (ostream &os, vtkIndent indent) override
| Methods invoked by print to print information about the object including superclasses. More...
virtual void | RenderPiece (vtkRenderer *, vtkActor *)
| Implemented by sub classes. More...
void | Render (vtkRenderer *ren, vtkActor *act) override
| This calls RenderPiece (in a for loop if streaming is necessary). More...
virtual MapperHashType | GenerateHash (vtkPolyData *)
| This hash integer is computed by concrete graphics implementation of this class. More...
double * | GetBounds () override
| Return bounding box (array of six doubles) of data expressed as (xmin,xmax, ymin,ymax, zmin,zmax). More...
void | GetBounds (double bounds[6]) override
| Get the bounds for this mapper as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
void | ShallowCopy (vtkAbstractMapper *m) override
| Make a shallow copy of this mapper. More...
virtual void | MapDataArrayToVertexAttribute (const char *vertexAttributeName, const char *dataArrayName, int fieldAssociation, int componentno=-1)
| Select a data array from the point/cell data and map it to a generic vertex attribute. More...
virtual void | MapDataArrayToMultiTextureAttribute (const char *textureName, const char *dataArrayName, int fieldAssociation, int componentno=-1)
virtual void | RemoveVertexAttributeMapping (const char *vertexAttributeName)
| Remove a vertex attribute mapping. More...
virtual void | RemoveAllVertexAttributeMappings ()
| Remove all vertex attributes. More...
vtkTypeBool | ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
| see vtkAlgorithm for details More...
virtual void | SetVBOShiftScaleMethod (int)
| A convenience method for enabling/disabling the VBO's shift+scale transform. More...
virtual int | GetVBOShiftScaleMethod ()
virtual void | SetPauseShiftScale (bool pauseShiftScale)
| Pause per-render updates to VBO shift+scale parameters. More...
virtual bool | GetPauseShiftScale ()
virtual void | PauseShiftScaleOn ()
virtual void | PauseShiftScaleOff ()
void | SetInputData (vtkPolyData *in)
| Specify the input data to map. More...
vtkPolyData * | GetInput ()
| Specify the input data to map. More...
void | Update (int port) override
| Bring this algorithm's outputs up-to-date. More...
void | Update () override
| Bring this algorithm's outputs up-to-date. More...
vtkTypeBool | Update (int port, vtkInformationVector *requests) override
| Bring this algorithm's outputs up-to-date. More...
vtkTypeBool | Update (vtkInformation *requests) override
| Bring this algorithm's outputs up-to-date. More...
virtual void | SetPiece (int)
| If you want only a part of the data, specify by setting the piece. More...
virtual int | GetPiece ()
| If you want only a part of the data, specify by setting the piece. More...
virtual void | SetNumberOfPieces (int)
| If you want only a part of the data, specify by setting the piece. More...
virtual int | GetNumberOfPieces ()
| If you want only a part of the data, specify by setting the piece. More...
virtual void | SetNumberOfSubPieces (int)
| If you want only a part of the data, specify by setting the piece. More...
virtual int | GetNumberOfSubPieces ()
| If you want only a part of the data, specify by setting the piece. More...
virtual void | SetGhostLevel (int)
| Set the number of ghost cells to return. More...
virtual int | GetGhostLevel ()
| Set the number of ghost cells to return. More...
virtual void | SetSeamlessU (bool)
| Accessors / Mutators for handling seams on wrapping surfaces. More...
virtual bool | GetSeamlessU ()
| Accessors / Mutators for handling seams on wrapping surfaces. More...
virtual void | SeamlessUOn ()
| Accessors / Mutators for handling seams on wrapping surfaces. More...
virtual void | SeamlessUOff ()
| Accessors / Mutators for handling seams on wrapping surfaces. More...
virtual void | SetSeamlessV (bool)
| Accessors / Mutators for handling seams on wrapping surfaces. More...
virtual bool | GetSeamlessV ()
| Accessors / Mutators for handling seams on wrapping surfaces. More...
virtual void | SeamlessVOn ()
| Accessors / Mutators for handling seams on wrapping surfaces. More...
virtual void | SeamlessVOff ()
| Accessors / Mutators for handling seams on wrapping surfaces. More...
Public Member Functions inherited from vtkMapper
vtkMapper * | NewInstance () const
vtkMTimeType | GetMTime () override
| Overload standard modified time function. More...
void | ReleaseGraphicsResources (vtkWindow *) override
| Release any graphics resources that are being consumed by this mapper. More...
virtual void | CreateDefaultLookupTable ()
| Create default lookup table. More...
const char * | GetColorModeAsString ()
| Return the method of coloring scalar data. More...
virtual void | SetScalarMode (int)
| Control how the filter works with scalar point data and cell attribute data. More...
virtual int | GetScalarMode ()
void | SetScalarModeToDefault ()
void | SetScalarModeToUsePointData ()
void | SetScalarModeToUseCellData ()
void | SetScalarModeToUsePointFieldData ()
void | SetScalarModeToUseCellFieldData ()
void | SetScalarModeToUseFieldData ()
virtual void | SetFieldDataTupleId (vtkIdType)
virtual vtkIdType | GetFieldDataTupleId ()
virtual char * | GetArrayName ()
| Set/Get the array name or number and component to color by. More...
virtual void | SetArrayName (const char *)
virtual int | GetArrayId ()
virtual void | SetArrayId (int)
virtual int | GetArrayAccessMode ()
virtual void | SetArrayAccessMode (int)
virtual int | GetArrayComponent ()
virtual void | SetArrayComponent (int)
const char * | GetScalarModeAsString ()
| Return the method for obtaining scalar data. More...
void | SetRenderTime (double time)
| This instance variable is used by vtkLODActor to determine which mapper to use. More...
virtual double | GetRenderTime ()
vtkDataSet * | GetInput ()
| Get the input as a vtkDataSet. More...
vtkDataSet * | GetInputAsDataSet ()
| Get the input to this mapper as a vtkDataSet, instead of as a more specialized data type that the subclass may return from GetInput(). More...
virtual void | ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &, vtkProp *)
| allows a mapper to update a selections color buffers Called from a prop which in turn is called from the selector More...
virtual int | CanUseTextureMapForColoring (vtkDataObject *input)
| Returns if we can use texture maps for scalar coloring. More...
void | ClearColorArrays ()
| Call to force a rebuild of color result arrays on next MapScalars. More...
vtkUnsignedCharArray * | GetColorMapColors ()
| Provide read access to the color array. More...
vtkFloatArray * | GetColorCoordinates ()
| Provide read access to the color texture coordinate array. More...
vtkImageData * | GetColorTextureMap ()
| Provide read access to the color texture array. More...
void | SetLookupTable (vtkScalarsToColors *lut)
| Specify a lookup table for the mapper to use. More...
vtkScalarsToColors * | GetLookupTable ()
| Specify a lookup table for the mapper to use. More...
virtual void | SetScalarVisibility (vtkTypeBool)
| Turn on/off flag to control whether scalar data is used to color objects. More...
virtual vtkTypeBool | GetScalarVisibility ()
| Turn on/off flag to control whether scalar data is used to color objects. More...
virtual void | ScalarVisibilityOn ()
| Turn on/off flag to control whether scalar data is used to color objects. More...
virtual void | ScalarVisibilityOff ()
| Turn on/off flag to control whether scalar data is used to color objects. More...
virtual void | SetStatic (vtkTypeBool)
| Turn on/off flag to control whether the mapper's data is static. More...
virtual vtkTypeBool | GetStatic ()
| Turn on/off flag to control whether the mapper's data is static. More...
virtual void | StaticOn ()
| Turn on/off flag to control whether the mapper's data is static. More...
virtual void | StaticOff ()
| Turn on/off flag to control whether the mapper's data is static. More...
virtual void | SetColorMode (int)
| default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
virtual int | GetColorMode ()
| default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
void | SetColorModeToDefault ()
| default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
void | SetColorModeToMapScalars ()
| default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
void | SetColorModeToDirectScalars ()
| default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. More...
virtual void | SetInterpolateScalarsBeforeMapping (vtkTypeBool)
| By default, vertex color is used to map colors to a surface. More...
virtual vtkTypeBool | GetInterpolateScalarsBeforeMapping ()
| By default, vertex color is used to map colors to a surface. More...
virtual void | InterpolateScalarsBeforeMappingOn ()
| By default, vertex color is used to map colors to a surface. More...
virtual void | InterpolateScalarsBeforeMappingOff ()
| By default, vertex color is used to map colors to a surface. More...
virtual void | SetUseLookupTableScalarRange (vtkTypeBool)
| Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. More...
virtual vtkTypeBool | GetUseLookupTableScalarRange ()
| Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. More...
virtual void | UseLookupTableScalarRangeOn ()
| Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. More...
virtual void | UseLookupTableScalarRangeOff ()
| Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. More...
virtual void | SetScalarRange (double, double)
| Specify range in terms of scalar minimum and maximum (smin,smax). More...
void | SetScalarRange (double[2])
| Specify range in terms of scalar minimum and maximum (smin,smax). More...
virtual double * | GetScalarRange ()
| Specify range in terms of scalar minimum and maximum (smin,smax). More...
virtual void | GetScalarRange (double data[2])
| Specify range in terms of scalar minimum and maximum (smin,smax). More...
void | SelectColorArray (int arrayNum)
| When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. More...
void | SelectColorArray (const char *arrayName)
| When ScalarMode is set to UsePointFieldData or UseCellFieldData, you can specify which array to use for coloring using these methods. More...
void | ColorByArrayComponent (int arrayNum, int component)
| Legacy: These methods used to be used to specify the array component. More...
void | ColorByArrayComponent (const char *arrayName, int component)
| Legacy: These methods used to be used to specify the array component. More...
void | SetRelativeCoincidentTopologyPolygonOffsetParameters (double factor, double units)
| Used to set the polygon offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
void | GetRelativeCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
| Used to set the polygon offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
void | SetRelativeCoincidentTopologyLineOffsetParameters (double factor, double units)
| Used to set the line offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
void | GetRelativeCoincidentTopologyLineOffsetParameters (double &factor, double &units)
| Used to set the line offset values relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
void | SetRelativeCoincidentTopologyPointOffsetParameter (double units)
| Used to set the point offset value relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
void | GetRelativeCoincidentTopologyPointOffsetParameter (double &units)
| Used to set the point offset value relative to the global Used when ResolveCoincidentTopology is set to PolygonOffset. More...
void | GetCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
| Get the net parameters for handling coincident topology obtained by summing the global values with the relative values. More...
void | GetCoincidentTopologyLineOffsetParameters (double &factor, double &units)
| Get the net parameters for handling coincident topology obtained by summing the global values with the relative values. More...
void | GetCoincidentTopologyPointOffsetParameter (double &units)
| Get the net parameters for handling coincident topology obtained by summing the global values with the relative values. More...
virtual vtkUnsignedCharArray * | MapScalars (double alpha)
| Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array. More...
virtual vtkUnsignedCharArray * | MapScalars (double alpha, int &cellFlag)
| Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array. More...
virtual vtkUnsignedCharArray * | MapScalars (vtkDataSet *input, double alpha)
| Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array. More...
virtual vtkUnsignedCharArray * | MapScalars (vtkDataSet *input, double alpha, int &cellFlag)
| Map the scalars (if there are any scalars and ScalarVisibility is on) through the lookup table, returning an unsigned char RGBA array. More...
virtual bool | HasOpaqueGeometry ()
| Some introspection on the type of data the mapper will render used by props to determine if they should invoke the mapper on a specific rendering pass. More...
virtual bool | HasTranslucentPolygonalGeometry ()
| Some introspection on the type of data the mapper will render used by props to determine if they should invoke the mapper on a specific rendering pass. More...
virtual vtkSelection * | GetSelection ()
| Set/Get selection used to display particular points or cells in a second pass. More...
virtual void | SetSelection (vtkSelection *)
| Set/Get selection used to display particular points or cells in a second pass. More...
Public Member Functions inherited from vtkAbstractMapper3D
vtkAbstractMapper3D * | NewInstance () const
double | GetLength ()
| Return the diagonal length of this mappers bounding box. More...
virtual vtkTypeBool | IsARayCastMapper ()
| Is this a ray cast mapper? A subclass would return 1 if the ray caster is needed to generate an image from this mapper. More...
virtual vtkTypeBool | IsARenderIntoImageMapper ()
| Is this a "render into image" mapper? A subclass would return 1 if the mapper produces an image by rendering into a software image buffer. More...
void | GetClippingPlaneInDataCoords (vtkMatrix4x4 *propMatrix, int i, double planeEquation[4])
| Get the ith clipping plane as a homogeneous plane equation. More...
double * | GetCenter ()
| Return the Center of this mapper's data. More...
void | GetCenter (double center[3])
| Return the Center of this mapper's data. More...
Public Member Functions inherited from vtkAbstractMapper
vtkAbstractMapper * | NewInstance () const
void | SetClippingPlanes (vtkPlanes *planes)
| An alternative way to set clipping planes: use up to six planes found in the supplied instance of the implicit function vtkPlanes. More...
int | GetNumberOfClippingPlanes ()
| Get the number of clipping planes. More...
virtual double | GetTimeToDraw ()
| Get the time required to draw the geometry last time it was rendered. More...
void | AddClippingPlane (vtkPlane *plane)
| Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
void | RemoveClippingPlane (vtkPlane *plane)
| Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
void | RemoveAllClippingPlanes ()
| Specify clipping planes to be applied when the data is mapped (at most 6 clipping planes can be specified). More...
virtual void | SetClippingPlanes (vtkPlaneCollection *)
| Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
virtual vtkPlaneCollection * | GetClippingPlanes ()
| Get/Set the vtkPlaneCollection which specifies the clipping planes. More...
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm * | NewInstance () const
vtkTypeBool | 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...
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 | SetAbortExecuteAndUpdateTime ()
| Set AbortExecute Flag and update LastAbortTime. More...
void | UpdateProgress (double amount)
| Update the progress of the process object. More...
bool | CheckAbort ()
| Checks to see if this filter should abort. More...
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 | 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 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 vtkInformation * | GetInformation ()
| Set/Get the information object associated with this algorithm. More...
virtual void | SetInformation (vtkInformation *)
| Set/Get the information object associated with this algorithm. More...
bool | UsesGarbageCollector () const override
| Participate in garbage collection. More...
virtual void | SetAbortExecute (vtkTypeBool)
| Set/Get the AbortExecute flag for the process object. More...
virtual vtkTypeBool | GetAbortExecute ()
| Set/Get the AbortExecute flag for the process object. More...
virtual void | AbortExecuteOn ()
| Set/Get the AbortExecute flag for the process object. More...
virtual void | AbortExecuteOff ()
| Set/Get the AbortExecute flag for the process object. More...
virtual double | GetProgress ()
| Get the execution progress of a process object. More...
void | SetContainerAlgorithm (vtkAlgorithm *containerAlg)
| Set/get a Container algorithm for this algorithm. More...
vtkAlgorithm * | GetContainerAlgorithm ()
| Set/get a Container algorithm for this algorithm. More...
virtual void | SetAbortOutput (bool)
| Set/Get an internal variable used to communicate between the algorithm and executive. More...
virtual bool | GetAbortOutput ()
| Set/Get an internal variable used to communicate between the algorithm and executive. 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 ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
virtual double | GetProgressScale ()
| Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called. More...
void | SetProgressText (const char *ptext)
| Set the current text message associated with the progress state. More...
virtual char * | GetProgressText ()
| Set the current text message associated with the progress state. More...
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)
| Set the input data arrays that this algorithm will process. More...
virtual void | SetInputArrayToProcess (int idx, vtkInformation *info)
| Set the input data arrays that this algorithm will process. More...
virtual void | SetInputConnection (int port, vtkAlgorithmOutput *input)
| Set the connection for the given input port index. More...
virtual void | SetInputConnection (vtkAlgorithmOutput *input)
| Set the connection for the given input port index. More...
virtual void | AddInputConnection (int port, vtkAlgorithmOutput *input)
| Add a connection to the given input port index. More...
virtual void | AddInputConnection (vtkAlgorithmOutput *input)
| Add a connection to the given input port index. More...
virtual void | SetReleaseDataFlag (vtkTypeBool)
| Turn release data flag on or off for all output ports. More...
virtual vtkTypeBool | GetReleaseDataFlag ()
| Turn release data flag on or off for all output ports. More...
void | ReleaseDataFlagOn ()
| Turn release data flag on or off for all output ports. More...
void | ReleaseDataFlagOff ()
| Turn release data flag on or off for all output ports. More...
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)
| 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 * | GetUpdateExtent ()
| These functions return the update extent for output ports that use 3D extents. More...
int * | GetUpdateExtent (int port)
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int extent[6])
| These functions return the update extent for output ports that use 3D extents. More...
void | GetUpdateExtent (int port, int extent[6])
| These functions return the update extent for output ports that use 3D extents. More...
int | GetUpdatePiece ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdatePiece (int port)
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateNumberOfPieces ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateNumberOfPieces (int port)
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateGhostLevel ()
| These functions return the update extent for output ports that use piece extents. More...
int | GetUpdateGhostLevel (int port)
| These functions return the update extent for output ports that use piece extents. More...
void | SetProgressObserver (vtkProgressObserver *)
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
virtual vtkProgressObserver * | GetProgressObserver ()
| If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
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...
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)
vtkTypeBool | InvokeEvent (unsigned long event)
vtkTypeBool | InvokeEvent (const char *event)
std::string | GetObjectDescription () const override
| The object description printed in messages and PrintSelf output. 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)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand * | GetCommand (unsigned long tag)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObserver (vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObservers (unsigned long event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void | RemoveObservers (const char *event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool | HasObserver (const char *event, vtkCommand *)
| Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
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)
| 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, 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...
vtkTypeBool | InvokeEvent (unsigned long event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
vtkTypeBool | InvokeEvent (const char *event, void *callData)
| This method invokes an event and return whether the event was aborted or not. More...
virtual void | SetObjectName (const std::string &objectName)
| Set/get the name of this object for reporting purposes. More...
virtual std::string | GetObjectName () const
| Set/get the name of this object for reporting purposes. More...
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 | Register (vtkObjectBase *o)
| Increase the reference count (mark as used by another object). More...
virtual void | UnRegister (vtkObjectBase *o)
| Decrease the reference count (release by another object). More...
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...
virtual void | PrintHeader (ostream &os, vtkIndent indent)
| Methods invoked by print to print information about the object including superclasses. More...
virtual void | PrintTrailer (ostream &os, vtkIndent indent)
| Methods invoked by print to print information about the object including superclasses. More...

## Static Public Member Functions
static vtkPointGaussianMapper * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkPointGaussianMapper * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkPolyDataMapper
static vtkPolyDataMapper * | New ()
static vtkTypeBool | IsTypeOf (const char *type)
static vtkPolyDataMapper * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkMapper
static vtkTypeBool | IsTypeOf (const char *type)
static vtkMapper * | SafeDownCast (vtkObjectBase *o)
static void | SetResolveCoincidentTopology (int val)
| Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). More...
static int | GetResolveCoincidentTopology ()
| Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). More...
static void | SetResolveCoincidentTopologyToDefault ()
| Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). More...
static void | SetResolveCoincidentTopologyToOff ()
| Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). More...
static void | SetResolveCoincidentTopologyToPolygonOffset ()
| Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). More...
static void | SetResolveCoincidentTopologyToShiftZBuffer ()
| Set/Get a global flag that controls whether coincident topology (e.g., a line on top of a polygon) is shifted to avoid z-buffer resolution (and hence rendering problems). More...
static void | SetResolveCoincidentTopologyPolygonOffsetParameters (double factor, double units)
| Used to set the polygon offset scale factor and units. More...
static void | GetResolveCoincidentTopologyPolygonOffsetParameters (double &factor, double &units)
| Used to set the polygon offset scale factor and units. More...
static void | SetResolveCoincidentTopologyLineOffsetParameters (double factor, double units)
| Used to set the line offset scale factor and units. More...
static void | GetResolveCoincidentTopologyLineOffsetParameters (double &factor, double &units)
| Used to set the line offset scale factor and units. More...
static void | SetResolveCoincidentTopologyPointOffsetParameter (double units)
| Used to set the point offset value Used when ResolveCoincidentTopology is set to PolygonOffset. More...
static void | GetResolveCoincidentTopologyPointOffsetParameter (double &units)
| Used to set the point offset value Used when ResolveCoincidentTopology is set to PolygonOffset. More...
static void | SetResolveCoincidentTopologyPolygonOffsetFaces (int faces)
| Used when ResolveCoincidentTopology is set to PolygonOffset. More...
static int | GetResolveCoincidentTopologyPolygonOffsetFaces ()
| Used when ResolveCoincidentTopology is set to PolygonOffset. More...
static void | SetResolveCoincidentTopologyZShift (double val)
| Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. More...
static double | GetResolveCoincidentTopologyZShift ()
| Used to set the z-shift if ResolveCoincidentTopology is set to ShiftZBuffer. More...
Static Public Member Functions inherited from vtkAbstractMapper3D
static vtkTypeBool | IsTypeOf (const char *type)
static vtkAbstractMapper3D * | SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractMapper
static vtkTypeBool | IsTypeOf (const char *type)
static vtkAbstractMapper * | SafeDownCast (vtkObjectBase *o)
static vtkDataArray * | GetScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
| Internal helper function for getting the active scalars. More...
static vtkAbstractArray * | GetAbstractScalars (vtkDataSet *input, int scalarMode, int arrayAccessMode, int arrayId, const char *arrayName, int &cellFlag)
| Internal helper function for getting the active scalars as an abstract array. More...
static vtkUnsignedCharArray * | GetGhostArray (vtkDataSet *input, int scalarMode, unsigned char &ghostsToSkip)
| Returns the ghost array associated with the corresponding scalar mode, if present. More...
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 vtkInformationIntegerKey * | ABORTED ()
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 (vtkTypeBool val)
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void | GlobalWarningDisplayOn ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void | GlobalWarningDisplayOff ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static vtkTypeBool | GetGlobalWarningDisplay ()
| This is a global flag that controls whether any debug, warning or error messages are displayed. More...
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
| vtkPointGaussianMapper ()
| ~vtkPointGaussianMapper () override
Protected Member Functions inherited from vtkPolyDataMapper
| vtkPolyDataMapper ()
| ~vtkPolyDataMapper () override=default
virtual void | ComputeBounds ()
| Called in GetBounds(). More...
int | FillInputPortInformation (int, vtkInformation *) override
| Fill the input port information objects for this algorithm. More...
Protected Member Functions inherited from vtkMapper
| vtkMapper ()
| ~vtkMapper () override
void | MapScalarsToTexture (vtkAbstractArray *scalars, double alpha)
Protected Member Functions inherited from vtkAbstractMapper3D
| vtkAbstractMapper3D ()
| ~vtkAbstractMapper3D () override=default
Protected Member Functions inherited from vtkAbstractMapper
| vtkAbstractMapper ()
| ~vtkAbstractMapper () override
Protected Member Functions inherited from vtkAlgorithm
| vtkAlgorithm ()
| ~vtkAlgorithm () override
bool | CheckUpstreamAbort ()
| Checks to see if an upstream filter has been aborted. More...
virtual int | FillOutputPortInformation (int port, vtkInformation *info)
| Fill the output port information objects for this algorithm. More...
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 association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
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...
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)
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)
| Filters that have multiple connections on one port can use this signature. More...
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)
| 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, 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)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkDataArray * | GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
| Filters that have multiple connections on one port can use this signature. More...
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)
| 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, 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)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
| Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray * | GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
| Filters that have multiple connections on one port can use this signature. More...
virtual void | SetErrorCode (unsigned long)
| The error code contains a possible error that occurred while reading or writing the file. More...
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 ()
| These methods allow a command to exclusively grab all events. More...
Protected Member Functions inherited from vtkObjectBase
| vtkObjectBase ()
virtual | ~vtkObjectBase ()
| vtkObjectBase (const vtkObjectBase &)
void | operator= (const vtkObjectBase &)

## Protected Attributes
char * | ScaleArray
int | ScaleArrayComponent
char * | OpacityArray
int | OpacityArrayComponent
char * | SplatShaderCode
vtkPiecewiseFunction * | ScaleFunction
int | ScaleTableSize
vtkPiecewiseFunction * | ScalarOpacityFunction
int | OpacityTableSize
double | ScaleFactor
vtkTypeBool | Emissive
float | TriangleScale
Protected Attributes inherited from vtkPolyDataMapper
int | Piece
int | NumberOfPieces
int | NumberOfSubPieces
int | GhostLevel
bool | SeamlessU
bool | SeamlessV
int | ShiftScaleMethod
bool | PauseShiftScale
Protected Attributes inherited from vtkMapper
vtkUnsignedCharArray * | Colors
vtkTypeBool | InterpolateScalarsBeforeMapping
vtkFloatArray * | ColorCoordinates
vtkImageData * | ColorTextureMap
vtkScalarsToColors * | LookupTable
vtkTypeBool | ScalarVisibility
vtkTimeStamp | BuildTime
double | ScalarRange [2]
vtkTypeBool | UseLookupTableScalarRange
int | ColorMode
int | ScalarMode
double | RenderTime
int | ArrayId
char * | ArrayName
int | ArrayComponent
int | ArrayAccessMode
vtkIdType | FieldDataTupleId
vtkTypeBool | Static
double | CoincidentPolygonFactor
double | CoincidentPolygonOffset
double | CoincidentLineFactor
double | CoincidentLineOffset
double | CoincidentPointOffset
vtkSelection * | Selection = nullptr
Protected Attributes inherited from vtkAbstractMapper3D
double | Bounds [6]
double | Center [3]
Protected Attributes inherited from vtkAbstractMapper
vtkTimerLog * | Timer
double | TimeToDraw
vtkWindow * | LastWindow
vtkPlaneCollection * | ClippingPlanes
Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp | LastAbortCheckTime
vtkInformation * | Information
double | Progress
char * | ProgressText
vtkProgressObserver * | ProgressObserver
unsigned long | ErrorCode
| The error code contains a possible error that occurred while reading or writing the file. More...
Protected Attributes inherited from vtkObject
bool | Debug
vtkTimeStamp | MTime
vtkSubjectHelper * | SubjectHelper
std::string | ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > | ReferenceCount
vtkWeakPointerBase ** | WeakPointers

## Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< 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 vtkTimeStamp | LastAbortTime
static vtkExecutive * | DefaultExecutivePrototype

## Detailed Description

draw PointGaussians using imposters

A mapper that uses imposters to draw gaussian splats or other shapes if custom shader code is set. Supports transparency and picking as well. It draws all the points and does not require cell arrays. If cell arrays are provided it will only draw the points used by the Verts cell array. The shape of the imposter is a triangle.

Online Examples:

Tests:
  vtkPointGaussianMapper (Tests)

Definition at line 36 of file vtkPointGaussianMapper.h.

## Member Typedef Documentation

## ◆ Superclass

typedef vtkPolyDataMapper vtkPointGaussianMapper::Superclass

Definition at line 40 of file vtkPointGaussianMapper.h.

## Constructor & Destructor Documentation

## ◆ vtkPointGaussianMapper()

vtkPointGaussianMapper::vtkPointGaussianMapper | ( |  | ) |
| protected

## ◆ ~vtkPointGaussianMapper()

vtkPointGaussianMapper::~vtkPointGaussianMapper | ( |  | ) |
| overrideprotected

## Member Function Documentation

## ◆ New()

static vtkPointGaussianMapper* vtkPointGaussianMapper::New | ( |  | ) |
| static

## ◆ IsTypeOf()

static vtkTypeBool vtkPointGaussianMapper::IsTypeOf | ( | const char * | type | ) |
| static

## ◆ IsA()

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

Reimplemented in vtkOpenGLPointGaussianMapper.

## ◆ SafeDownCast()

static vtkPointGaussianMapper* vtkPointGaussianMapper::SafeDownCast | ( | vtkObjectBase * | o | ) |
| static

## ◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPointGaussianMapper::NewInstanceInternal | ( |  | ) | const
| protectedvirtual

Reimplemented from vtkPolyDataMapper.

Reimplemented in vtkOpenGLPointGaussianMapper.

## ◆ NewInstance()

vtkPointGaussianMapper* vtkPointGaussianMapper::NewInstance | ( |  | ) | const

## ◆ PrintSelf()

void vtkPointGaussianMapper::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 vtkMapper.

Reimplemented in vtkOpenGLPointGaussianMapper.

## ◆ SetScaleFunction()

void vtkPointGaussianMapper::SetScaleFunction | ( | vtkPiecewiseFunction * |  | ) |

Set/Get the optional scale transfer function.

This is only used when a ScaleArray is also specified.

## ◆ GetScaleFunction()

virtual vtkPiecewiseFunction* vtkPointGaussianMapper::GetScaleFunction | ( |  | ) |
| virtual

Set/Get the optional scale transfer function.

This is only used when a ScaleArray is also specified.

## ◆ SetScaleTableSize()

virtual void vtkPointGaussianMapper::SetScaleTableSize | ( | int |  | ) |
| virtual

The size of the table used in computing scale, used when converting a vtkPiecewiseFunction to a table.

## ◆ GetScaleTableSize()

virtual int vtkPointGaussianMapper::GetScaleTableSize | ( |  | ) |
| virtual

The size of the table used in computing scale, used when converting a vtkPiecewiseFunction to a table.

## ◆ SetScaleArray()

virtual void vtkPointGaussianMapper::SetScaleArray | ( | const char * |  | ) |
| virtual

Convenience method to set the array to scale with.

## ◆ GetScaleArray()

virtual char* vtkPointGaussianMapper::GetScaleArray | ( |  | ) |
| virtual

Convenience method to set the array to scale with.

## ◆ SetScaleArrayComponent()

virtual void vtkPointGaussianMapper::SetScaleArrayComponent | ( | int |  | ) |
| virtual

Convenience method to set the component of the array to scale with.

## ◆ GetScaleArrayComponent()

virtual int vtkPointGaussianMapper::GetScaleArrayComponent | ( |  | ) |
| virtual

Convenience method to set the component of the array to scale with.

## ◆ SetScaleFactor()

virtual void vtkPointGaussianMapper::SetScaleFactor | ( | double |  | ) |
| virtual

Set the default scale factor of the point gaussians.

This defaults to 1.0. All radius computations will be scaled by the factor including the ScaleArray. If a vtkPiecewideFunction is used the scaling happens prior to the function lookup. A scale factor of 0.0 indicates that the splats should be rendered as simple points.

## ◆ GetScaleFactor()

virtual double vtkPointGaussianMapper::GetScaleFactor | ( |  | ) |
| virtual

Set the default scale factor of the point gaussians.

This defaults to 1.0. All radius computations will be scaled by the factor including the ScaleArray. If a vtkPiecewideFunction is used the scaling happens prior to the function lookup. A scale factor of 0.0 indicates that the splats should be rendered as simple points.

## ◆ SetEmissive()

virtual void vtkPointGaussianMapper::SetEmissive | ( | vtkTypeBool |  | ) |
| virtual

Treat the points/splats as emissive light sources.

The default is true.

## ◆ GetEmissive()

virtual vtkTypeBool vtkPointGaussianMapper::GetEmissive | ( |  | ) |
| virtual

Treat the points/splats as emissive light sources.

The default is true.

## ◆ EmissiveOn()

virtual void vtkPointGaussianMapper::EmissiveOn | ( |  | ) |
| virtual

Treat the points/splats as emissive light sources.

The default is true.

## ◆ EmissiveOff()

virtual void vtkPointGaussianMapper::EmissiveOff | ( |  | ) |
| virtual

Treat the points/splats as emissive light sources.

The default is true.

## ◆ SetScalarOpacityFunction()

void vtkPointGaussianMapper::SetScalarOpacityFunction | ( | vtkPiecewiseFunction * |  | ) |

Set/Get the optional opacity transfer function.

This is only used when an OpacityArray is also specified.

## ◆ GetScalarOpacityFunction()

virtual vtkPiecewiseFunction* vtkPointGaussianMapper::GetScalarOpacityFunction | ( |  | ) |
| virtual

Set/Get the optional opacity transfer function.

This is only used when an OpacityArray is also specified.

## ◆ SetOpacityTableSize()

virtual void vtkPointGaussianMapper::SetOpacityTableSize | ( | int |  | ) |
| virtual

The size of the table used in computing opacities, used when converting a vtkPiecewiseFunction to a table.

## ◆ GetOpacityTableSize()

virtual int vtkPointGaussianMapper::GetOpacityTableSize | ( |  | ) |
| virtual

The size of the table used in computing opacities, used when converting a vtkPiecewiseFunction to a table.

## ◆ SetOpacityArray()

virtual void vtkPointGaussianMapper::SetOpacityArray | ( | const char * |  | ) |
| virtual

Method to set the optional opacity array.

If specified this array will be used to generate the opacity values.

## ◆ GetOpacityArray()

virtual char* vtkPointGaussianMapper::GetOpacityArray | ( |  | ) |
| virtual

Method to set the optional opacity array.

If specified this array will be used to generate the opacity values.

## ◆ SetOpacityArrayComponent()

virtual void vtkPointGaussianMapper::SetOpacityArrayComponent | ( | int |  | ) |
| virtual

Convenience method to set the component of the array to opacify with.

## ◆ GetOpacityArrayComponent()

virtual int vtkPointGaussianMapper::GetOpacityArrayComponent | ( |  | ) |
| virtual

Convenience method to set the component of the array to opacify with.

## ◆ SetSplatShaderCode()

virtual void vtkPointGaussianMapper::SetSplatShaderCode | ( | const char * |  | ) |
| virtual

Method to override the fragment shader code for the splat.

You can set this to draw other shapes. For the OPenGL2 backend some of the variables you can use and/or modify include, opacity - 0.0 to 1.0 diffuseColor - vec3 ambientColor - vec3 offsetVCVSOutput - vec2 offset in view coordinates from the splat center

## ◆ GetSplatShaderCode()

virtual char* vtkPointGaussianMapper::GetSplatShaderCode | ( |  | ) |
| virtual

Method to override the fragment shader code for the splat.

You can set this to draw other shapes. For the OPenGL2 backend some of the variables you can use and/or modify include, opacity - 0.0 to 1.0 diffuseColor - vec3 ambientColor - vec3 offsetVCVSOutput - vec2 offset in view coordinates from the splat center

## ◆ SetTriangleScale()

virtual void vtkPointGaussianMapper::SetTriangleScale | ( | float |  | ) |
| virtual

When drawing triangles as opposed too point mode (triangles are for splats shaders that are bigger than a pixel) this controls how large the triangle will be.

By default it is large enough to contain a cicle of radius 3.0*scale which works well for gaussian splats as after 3.0 standard deviations the opacity is near zero. For custom shader codes a different value can be used. Generally you should use the lowest value you can as it will result in fewer fragments. For example if your custom shader only draws a disc of radius 1.0*scale, then set this to 1.0 to avoid sending many fragments to the shader that will just get discarded.

## ◆ GetTriangleScale()

virtual float vtkPointGaussianMapper::GetTriangleScale | ( |  | ) |
| virtual

When drawing triangles as opposed too point mode (triangles are for splats shaders that are bigger than a pixel) this controls how large the triangle will be.

By default it is large enough to contain a cicle of radius 3.0*scale which works well for gaussian splats as after 3.0 standard deviations the opacity is near zero. For custom shader codes a different value can be used. Generally you should use the lowest value you can as it will result in fewer fragments. For example if your custom shader only draws a disc of radius 1.0*scale, then set this to 1.0 to avoid sending many fragments to the shader that will just get discarded.

## ◆ GetSupportsSelection()

bool vtkPointGaussianMapper::GetSupportsSelection | ( |  | ) |
| inlineoverridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection.

Reimplemented from vtkMapper.

Definition at line 172 of file vtkPointGaussianMapper.h.

## Member Data Documentation

## ◆ ScaleArray

char* vtkPointGaussianMapper::ScaleArray
| protected

Definition at line 178 of file vtkPointGaussianMapper.h.

## ◆ ScaleArrayComponent

int vtkPointGaussianMapper::ScaleArrayComponent
| protected

Definition at line 179 of file vtkPointGaussianMapper.h.

## ◆ OpacityArray

char* vtkPointGaussianMapper::OpacityArray
| protected

Definition at line 180 of file vtkPointGaussianMapper.h.

## ◆ OpacityArrayComponent

int vtkPointGaussianMapper::OpacityArrayComponent
| protected

Definition at line 181 of file vtkPointGaussianMapper.h.

## ◆ SplatShaderCode

char* vtkPointGaussianMapper::SplatShaderCode
| protected

Definition at line 182 of file vtkPointGaussianMapper.h.

## ◆ ScaleFunction

vtkPiecewiseFunction* vtkPointGaussianMapper::ScaleFunction
| protected

Definition at line 184 of file vtkPointGaussianMapper.h.

## ◆ ScaleTableSize

int vtkPointGaussianMapper::ScaleTableSize
| protected

Definition at line 185 of file vtkPointGaussianMapper.h.

## ◆ ScalarOpacityFunction

vtkPiecewiseFunction* vtkPointGaussianMapper::ScalarOpacityFunction
| protected

Definition at line 187 of file vtkPointGaussianMapper.h.

## ◆ OpacityTableSize

int vtkPointGaussianMapper::OpacityTableSize
| protected

Definition at line 188 of file vtkPointGaussianMapper.h.

## ◆ ScaleFactor

double vtkPointGaussianMapper::ScaleFactor
| protected

Definition at line 190 of file vtkPointGaussianMapper.h.

## ◆ Emissive

vtkTypeBool vtkPointGaussianMapper::Emissive
| protected

Definition at line 191 of file vtkPointGaussianMapper.h.

## ◆ TriangleScale

float vtkPointGaussianMapper::TriangleScale
| protected

Definition at line 193 of file vtkPointGaussianMapper.h.

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

- Rendering/Core/vtkPointGaussianMapper.h