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

Representation for showing point data as sprites, including gaussian splats, spheres, or some custom shaded representation. More...

#include <vtkPointGaussianRepresentation.h>

Inheritance diagram for vtkPointGaussianRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkPointGaussianRepresentation:
Collaboration graph
[legend]

Public Types

enum  ShaderPresets {
  GAUSSIAN_BLUR, SPHERE, BLACK_EDGED_CIRCLE, PLAIN_CIRCLE,
  TRIANGLE, SQUARE_OUTLINE, NUMBER_OF_PRESETS
}
 An enum specifying some preset fragment shaders. More...
 
typedef vtkPVDataRepresentation Superclass
 
- Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
void SetLookupTable (vtkScalarsToColors *lut)
 Use to set the color map for the data in this representation. More...
 
virtual void SetVisibility (bool val)
 Use to set whether the data in this representation is visible or not. More...
 
virtual void SetEmissive (bool val)
 Use to set whether the splat emits light. More...
 
virtual void SetMapScalars (int val)
 Use to make sure scalars will be mapped through lookup table, and not inadvertently used as colors by themselves. More...
 
virtual void SetOrientation (double, double, double)
 
virtual void SetOrigin (double, double, double)
 
virtual void SetPickable (int val)
 
virtual void SetPosition (double, double, double)
 
virtual void SetScale (double, double, double)
 
virtual void SetAmbientColor (double r, double g, double b)
 
virtual void SetColor (double r, double g, double b)
 
virtual void SetDiffuseColor (double r, double g, double b)
 
virtual void SetEdgeColor (double r, double g, double b)
 
virtual void SetInterpolation (int val)
 
virtual void SetLineWidth (double val)
 
virtual void SetOpacity (double val)
 
virtual void SetPointSize (double val)
 
virtual void SetSpecularColor (double r, double g, double b)
 
virtual void SetSpecularPower (double val)
 
virtual void SetSplatSize (double radius)
 Sets the radius of the gaussian splats if there is no scale array or if the scale array is disabled. More...
 
void SelectShaderPreset (int preset)
 Allows to select one of several preset options for shading the points. More...
 
void SetCustomShader (const char *shaderString)
 Sets the snippet of fragment shader code used to color the sprites. More...
 
void SelectScaleArray (int, int, int, int, const char *name)
 Sets the point array to scale the guassians by. More...
 
void SetScaleTransferFunction (vtkPiecewiseFunction *pwf)
 Sets a vtkPiecewiseFunction to use in mapping array values to sprite sizes. More...
 
void SetOpacityTransferFunction (vtkPiecewiseFunction *pwf)
 Sets a vtkPiecewiseFunction to use in mapping array values to sprite opacities. More...
 
void SelectOpacityArray (int, int, int, int, const char *name)
 Sets the point array to use in calculating point sprite opacities. More...
 
void SetOpacityByArray (bool newVal)
 Enables or disables setting opacity by an array. More...
 
virtual bool GetOpacityByArray ()
 Enables or disables setting opacity by an array. More...
 
virtual void OpacityByArrayOn ()
 Enables or disables setting opacity by an array. More...
 
virtual void OpacityByArrayOff ()
 Enables or disables setting opacity by an array. More...
 
void SetScaleByArray (bool newVal)
 Enables or disables scaling by a data array vs. More...
 
virtual bool GetScaleByArray ()
 Enables or disables scaling by a data array vs. More...
 
virtual void ScaleByArrayOn ()
 Enables or disables scaling by a data array vs. More...
 
virtual void ScaleByArrayOff ()
 Enables or disables scaling by a data array vs. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void MarkModified ()
 This is one of the most important functions. More...
 
virtual unsigned int Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
 Initialize the representation with an identifier range so each internal representation can own a unique ID. More...
 
unsigned int GetUniqueIdentifier ()
 Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...
 
virtual bool GetVisibility ()
 
virtual vtkDataObject * GetRenderedDataObject (int vtkNotUsed(port))
 Returns the data object that is rendered from the given input port. More...
 
virtual void SetForcedCacheKey (double val)
 Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More...
 
virtual void SetForceUseCache (bool val)
 
bool GetUsingCacheForUpdate ()
 Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More...
 
virtual bool GetNeedUpdate ()
 
virtual vtkAlgorithmOutput * GetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port, int conn)
 
vtkView * GetView () const
 Provides access to the view. More...
 
virtual void SetUpdateTime (double time)
 Set the update time. More...
 
virtual double GetUpdateTime ()
 Set the update time. More...
 
virtual bool GetUpdateTimeValid ()
 Set whether the UpdateTime is valid. More...
 
virtual void SetUseCache (bool)
 
virtual void SetCacheKey (double val)
 
virtual double GetCacheKey ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool GetUseCache ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPointGaussianRepresentationSafeDownCast (vtkObject *o)
 
static vtkPointGaussianRepresentationNew ()
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPointGaussianRepresentation ()
 
virtual ~vtkPointGaussianRepresentation ()
 
virtual bool AddToView (vtkView *view)
 Making these methods public. More...
 
virtual bool RemoveFromView (vtkView *view)
 Making these methods public. More...
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Overridden to invoke vtkCommand::UpdateDataEvent. More...
 
void UpdateColoringParameters ()
 
virtual void SetLastScaleArray (const char *)
 
virtual void SetLastOpacityArray (const char *)
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual bool IsCached (double cache_key)
 Subclasses should override this method when they support caching to indicate if the particular key is cached. More...
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

vtkSmartPointer< vtkActor > Actor
 
vtkSmartPointer< vtkPointGaussianMapper > Mapper
 
vtkSmartPointer< vtkPolyData > ProcessedData
 
bool ScaleByArray
 
char * LastScaleArray
 
bool OpacityByArray
 
char * LastOpacityArray
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Detailed Description

Representation for showing point data as sprites, including gaussian splats, spheres, or some custom shaded representation.

Definition at line 35 of file vtkPointGaussianRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkPointGaussianRepresentation.h.

Member Enumeration Documentation

◆ ShaderPresets

An enum specifying some preset fragment shaders.

Enumerator
GAUSSIAN_BLUR 
SPHERE 
BLACK_EDGED_CIRCLE 
PLAIN_CIRCLE 
TRIANGLE 
SQUARE_OUTLINE 
NUMBER_OF_PRESETS 

Definition at line 97 of file vtkPointGaussianRepresentation.h.

Constructor & Destructor Documentation

◆ vtkPointGaussianRepresentation()

vtkPointGaussianRepresentation::vtkPointGaussianRepresentation ( )
protected

◆ ~vtkPointGaussianRepresentation()

virtual vtkPointGaussianRepresentation::~vtkPointGaussianRepresentation ( )
protectedvirtual

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPointGaussianRepresentation::GetClassName ( )
virtual

Reimplemented from vtkPVDataRepresentation.

◆ IsTypeOf()

static int vtkPointGaussianRepresentation::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPointGaussianRepresentation::IsA ( const char *  type)
virtual

Reimplemented from vtkPVDataRepresentation.

◆ SafeDownCast()

static vtkPointGaussianRepresentation* vtkPointGaussianRepresentation::SafeDownCast ( vtkObject *  o)
static

◆ New()

static vtkPointGaussianRepresentation* vtkPointGaussianRepresentation::New ( )
static

◆ PrintSelf()

virtual void vtkPointGaussianRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

◆ ProcessViewRequest()

virtual int vtkPointGaussianRepresentation::ProcessViewRequest ( vtkInformationRequestKey *  request_type,
vtkInformation *  inInfo,
vtkInformation *  outInfo 
)
virtual

vtkAlgorithm::ProcessRequest() equivalent for rendering passes.

This is typically called by the vtkView to request meta-data from the representations or ask them to perform certain tasks e.g. PrepareForRendering. Overridden to skip processing when visibility if off.

Reimplemented from vtkPVDataRepresentation.

◆ SetLookupTable()

void vtkPointGaussianRepresentation::SetLookupTable ( vtkScalarsToColors *  lut)

Use to set the color map for the data in this representation.

◆ SetVisibility()

virtual void vtkPointGaussianRepresentation::SetVisibility ( bool  val)
virtual

Use to set whether the data in this representation is visible or not.

Reimplemented from vtkPVDataRepresentation.

◆ SetEmissive()

virtual void vtkPointGaussianRepresentation::SetEmissive ( bool  val)
virtual

Use to set whether the splat emits light.

◆ SetMapScalars()

virtual void vtkPointGaussianRepresentation::SetMapScalars ( int  val)
virtual

Use to make sure scalars will be mapped through lookup table, and not inadvertently used as colors by themselves.

◆ SetOrientation()

virtual void vtkPointGaussianRepresentation::SetOrientation ( double  ,
double  ,
double   
)
virtual

◆ SetOrigin()

virtual void vtkPointGaussianRepresentation::SetOrigin ( double  ,
double  ,
double   
)
virtual

◆ SetPickable()

virtual void vtkPointGaussianRepresentation::SetPickable ( int  val)
virtual

◆ SetPosition()

virtual void vtkPointGaussianRepresentation::SetPosition ( double  ,
double  ,
double   
)
virtual

◆ SetScale()

virtual void vtkPointGaussianRepresentation::SetScale ( double  ,
double  ,
double   
)
virtual

◆ SetAmbientColor()

virtual void vtkPointGaussianRepresentation::SetAmbientColor ( double  r,
double  g,
double  b 
)
virtual

◆ SetColor()

virtual void vtkPointGaussianRepresentation::SetColor ( double  r,
double  g,
double  b 
)
virtual

◆ SetDiffuseColor()

virtual void vtkPointGaussianRepresentation::SetDiffuseColor ( double  r,
double  g,
double  b 
)
virtual

◆ SetEdgeColor()

virtual void vtkPointGaussianRepresentation::SetEdgeColor ( double  r,
double  g,
double  b 
)
virtual

◆ SetInterpolation()

virtual void vtkPointGaussianRepresentation::SetInterpolation ( int  val)
virtual

◆ SetLineWidth()

virtual void vtkPointGaussianRepresentation::SetLineWidth ( double  val)
virtual

◆ SetOpacity()

virtual void vtkPointGaussianRepresentation::SetOpacity ( double  val)
virtual

◆ SetPointSize()

virtual void vtkPointGaussianRepresentation::SetPointSize ( double  val)
virtual

◆ SetSpecularColor()

virtual void vtkPointGaussianRepresentation::SetSpecularColor ( double  r,
double  g,
double  b 
)
virtual

◆ SetSpecularPower()

virtual void vtkPointGaussianRepresentation::SetSpecularPower ( double  val)
virtual

◆ SetSplatSize()

virtual void vtkPointGaussianRepresentation::SetSplatSize ( double  radius)
virtual

Sets the radius of the gaussian splats if there is no scale array or if the scale array is disabled.

Defaults to 1.

◆ SelectShaderPreset()

void vtkPointGaussianRepresentation::SelectShaderPreset ( int  preset)

Allows to select one of several preset options for shading the points.

◆ SetCustomShader()

void vtkPointGaussianRepresentation::SetCustomShader ( const char *  shaderString)

Sets the snippet of fragment shader code used to color the sprites.

◆ SelectScaleArray()

void vtkPointGaussianRepresentation::SelectScaleArray ( int  ,
int  ,
int  ,
int  ,
const char *  name 
)

Sets the point array to scale the guassians by.

The array should be a float array. The first four parameters are unused and only needed for the ParaView GUI's signature recognition.

◆ SetScaleTransferFunction()

void vtkPointGaussianRepresentation::SetScaleTransferFunction ( vtkPiecewiseFunction *  pwf)

Sets a vtkPiecewiseFunction to use in mapping array values to sprite sizes.

Performance decreases (along with understandability) when large values are used for sprite sizes. This is only used when "SetScaleArray" is also set.

◆ SetOpacityTransferFunction()

void vtkPointGaussianRepresentation::SetOpacityTransferFunction ( vtkPiecewiseFunction *  pwf)

Sets a vtkPiecewiseFunction to use in mapping array values to sprite opacities.

Only used when "Opacity Array" is set.

◆ SelectOpacityArray()

void vtkPointGaussianRepresentation::SelectOpacityArray ( int  ,
int  ,
int  ,
int  ,
const char *  name 
)

Sets the point array to use in calculating point sprite opacities.

The array should be a float or double array. The first four parameters are unused and only needed for the ParaView GUI's signature recognition.

◆ SetOpacityByArray()

void vtkPointGaussianRepresentation::SetOpacityByArray ( bool  newVal)

Enables or disables setting opacity by an array.

Set which array should be used for opacity with SelectOpacityArray, and set an opacity transfer function with SetOpacityTransferFunction.

◆ GetOpacityByArray()

virtual bool vtkPointGaussianRepresentation::GetOpacityByArray ( )
virtual

Enables or disables setting opacity by an array.

Set which array should be used for opacity with SelectOpacityArray, and set an opacity transfer function with SetOpacityTransferFunction.

◆ OpacityByArrayOn()

virtual void vtkPointGaussianRepresentation::OpacityByArrayOn ( )
virtual

Enables or disables setting opacity by an array.

Set which array should be used for opacity with SelectOpacityArray, and set an opacity transfer function with SetOpacityTransferFunction.

◆ OpacityByArrayOff()

virtual void vtkPointGaussianRepresentation::OpacityByArrayOff ( )
virtual

Enables or disables setting opacity by an array.

Set which array should be used for opacity with SelectOpacityArray, and set an opacity transfer function with SetOpacityTransferFunction.

◆ SetScaleByArray()

void vtkPointGaussianRepresentation::SetScaleByArray ( bool  newVal)

Enables or disables scaling by a data array vs.

a constant factor. Set which data array with SelectScaleArray and SetSplatSize.

◆ GetScaleByArray()

virtual bool vtkPointGaussianRepresentation::GetScaleByArray ( )
virtual

Enables or disables scaling by a data array vs.

a constant factor. Set which data array with SelectScaleArray and SetSplatSize.

◆ ScaleByArrayOn()

virtual void vtkPointGaussianRepresentation::ScaleByArrayOn ( )
virtual

Enables or disables scaling by a data array vs.

a constant factor. Set which data array with SelectScaleArray and SetSplatSize.

◆ ScaleByArrayOff()

virtual void vtkPointGaussianRepresentation::ScaleByArrayOff ( )
virtual

Enables or disables scaling by a data array vs.

a constant factor. Set which data array with SelectScaleArray and SetSplatSize.

◆ AddToView()

virtual bool vtkPointGaussianRepresentation::AddToView ( vtkView *  view)
protectedvirtual

Making these methods public.

When constructing composite representations, we need to call these methods directly on internal representations.

Reimplemented from vtkPVDataRepresentation.

◆ RemoveFromView()

virtual bool vtkPointGaussianRepresentation::RemoveFromView ( vtkView *  view)
protectedvirtual

Making these methods public.

When constructing composite representations, we need to call these methods directly on internal representations.

Reimplemented from vtkPVDataRepresentation.

◆ FillInputPortInformation()

virtual int vtkPointGaussianRepresentation::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

◆ RequestData()

virtual int vtkPointGaussianRepresentation::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkPVDataRepresentation.

◆ UpdateColoringParameters()

void vtkPointGaussianRepresentation::UpdateColoringParameters ( )
protected

◆ SetLastScaleArray()

virtual void vtkPointGaussianRepresentation::SetLastScaleArray ( const char *  )
protectedvirtual

◆ SetLastOpacityArray()

virtual void vtkPointGaussianRepresentation::SetLastOpacityArray ( const char *  )
protectedvirtual

Member Data Documentation

◆ Actor

vtkSmartPointer<vtkActor> vtkPointGaussianRepresentation::Actor
protected

Definition at line 178 of file vtkPointGaussianRepresentation.h.

◆ Mapper

vtkSmartPointer<vtkPointGaussianMapper> vtkPointGaussianRepresentation::Mapper
protected

Definition at line 179 of file vtkPointGaussianRepresentation.h.

◆ ProcessedData

vtkSmartPointer<vtkPolyData> vtkPointGaussianRepresentation::ProcessedData
protected

Definition at line 180 of file vtkPointGaussianRepresentation.h.

◆ ScaleByArray

bool vtkPointGaussianRepresentation::ScaleByArray
protected

Definition at line 184 of file vtkPointGaussianRepresentation.h.

◆ LastScaleArray

char* vtkPointGaussianRepresentation::LastScaleArray
protected

Definition at line 185 of file vtkPointGaussianRepresentation.h.

◆ OpacityByArray

bool vtkPointGaussianRepresentation::OpacityByArray
protected

Definition at line 187 of file vtkPointGaussianRepresentation.h.

◆ LastOpacityArray

char* vtkPointGaussianRepresentation::LastOpacityArray
protected

Definition at line 190 of file vtkPointGaussianRepresentation.h.


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