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

representation for showing cell and point labels. More...

#include <vtkDataLabelRepresentation.h>

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

Public Types

typedef vtkPVDataRepresentation Superclass
 
- Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void MarkModified ()
 This needs to be called on all instances of vtkGeometryRepresentation when the input is modified. More...
 
void SetPointLabelVisibility (int)
 
void SetPointFieldDataArrayName (const char *)
 
void SetPointLabelMode (int)
 
void SetPointLabelColor (double r, double g, double b)
 
void SetPointLabelOpacity (double)
 
void SetPointLabelFontFamily (int)
 
void SetPointLabelBold (int)
 
void SetPointLabelItalic (int)
 
void SetPointLabelShadow (int)
 
void SetPointLabelJustification (int)
 
void SetPointLabelFontSize (int)
 
void SetPointLabelFormat (const char *)
 
void SetCellLabelVisibility (int)
 
void SetCellFieldDataArrayName (const char *)
 
void SetCellLabelMode (int)
 
void SetCellLabelColor (double r, double g, double b)
 
void SetCellLabelOpacity (double)
 
void SetCellLabelFontFamily (int)
 
void SetCellLabelBold (int)
 
void SetCellLabelItalic (int)
 
void SetCellLabelShadow (int)
 
void SetCellLabelJustification (int)
 
void SetCellLabelFontSize (int)
 
void SetCellLabelFormat (const char *)
 
int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
virtual void SetVisibility (bool val)
 Get/Set the visibility for this representation. More...
 
virtual bool GetVisibility ()
 Get/Set the visibility for this representation. More...
 
void SetOrientation (double, double, double)
 Used to build the internal transform. More...
 
void SetOrigin (double, double, double)
 Used to build the internal transform. More...
 
void SetPosition (double, double, double)
 Used to build the internal transform. More...
 
void SetScale (double, double, double)
 Used to build the internal transform. More...
 
void SetUserTransform (const double[16])
 Used to build the internal transform. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
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 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 vtkDataLabelRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataLabelRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkDataLabelRepresentation ()
 
 ~vtkDataLabelRepresentation ()
 
virtual bool AddToView (vtkView *view)
 Adds the representation to the view. More...
 
virtual bool RemoveFromView (vtkView *view)
 Removes the representation to the view. More...
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill input port information. More...
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Subclasses should override this to connect inputs to the internal pipeline as necessary. More...
 
virtual bool IsCached (double cache_key)
 Overridden to check with the vtkPVCacheKeeper to see if the key is cached. More...
 
void UpdateTransform ()
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Static Protected Member Functions

static void OnWarningEvent (vtkObject *source, unsigned long, void *clientdata, void *)
 

Protected Attributes

vtkCompositeDataToUnstructuredGridFilterMergeBlocks
 
vtkPVCacheKeeperCacheKeeper
 
vtkLabeledDataMapper * PointLabelMapper
 
vtkTextProperty * PointLabelProperty
 
vtkActor2D * PointLabelActor
 
vtkCellCenters * CellCenters
 
vtkLabeledDataMapper * CellLabelMapper
 
vtkTextProperty * CellLabelProperty
 
vtkActor2D * CellLabelActor
 
vtkProp3D * TransformHelperProp
 
vtkTransform * Transform
 
vtkSmartPointer< vtkDataObject > Dataset
 
vtkCallbackCommand * WarningObserver
 
int PointLabelVisibility
 
int CellLabelVisibility
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Detailed Description

representation for showing cell and point labels.

vtkDataLabelRepresentation is a representation for showing cell and/or point labels. This representation relies on all the data being cloned on all nodes hence beware of using this representation for large datasets.

Caveat:
Note that vtkDataLabelRepresentation adds the label props to the non-composited renderer.
Thanks:
The addition of a transformation matrix was supported by CEA/DIF Commissariat a l'Energie Atomique, Centre DAM Ile-De-France, Arpajon, France.

Definition at line 48 of file vtkDataLabelRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 of file vtkDataLabelRepresentation.h.

Constructor & Destructor Documentation

◆ vtkDataLabelRepresentation()

vtkDataLabelRepresentation::vtkDataLabelRepresentation ( )
protected

◆ ~vtkDataLabelRepresentation()

vtkDataLabelRepresentation::~vtkDataLabelRepresentation ( )
protected

Member Function Documentation

◆ New()

static vtkDataLabelRepresentation* vtkDataLabelRepresentation::New ( )
static

◆ GetClassName()

virtual const char* vtkDataLabelRepresentation::GetClassName ( )
virtual

Reimplemented from vtkPVDataRepresentation.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVDataRepresentation.

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ MarkModified()

virtual void vtkDataLabelRepresentation::MarkModified ( )
virtual

This needs to be called on all instances of vtkGeometryRepresentation when the input is modified.

This is essential since the geometry filter does not have any real-input on the client side which messes with the Update requests.

Reimplemented from vtkPVDataRepresentation.

◆ SetVisibility()

virtual void vtkDataLabelRepresentation::SetVisibility ( bool  val)
virtual

Get/Set the visibility for this representation.

When the visibility of representation of false, all view passes are ignored.

Reimplemented from vtkPVDataRepresentation.

◆ GetVisibility()

virtual bool vtkDataLabelRepresentation::GetVisibility ( )
virtual

Get/Set the visibility for this representation.

When the visibility of representation of false, all view passes are ignored.

Reimplemented from vtkPVDataRepresentation.

◆ SetPointLabelVisibility()

void vtkDataLabelRepresentation::SetPointLabelVisibility ( int  )

◆ SetPointFieldDataArrayName()

void vtkDataLabelRepresentation::SetPointFieldDataArrayName ( const char *  )

◆ SetPointLabelMode()

void vtkDataLabelRepresentation::SetPointLabelMode ( int  )

◆ SetPointLabelColor()

void vtkDataLabelRepresentation::SetPointLabelColor ( double  r,
double  g,
double  b 
)

◆ SetPointLabelOpacity()

void vtkDataLabelRepresentation::SetPointLabelOpacity ( double  )

◆ SetPointLabelFontFamily()

void vtkDataLabelRepresentation::SetPointLabelFontFamily ( int  )

◆ SetPointLabelBold()

void vtkDataLabelRepresentation::SetPointLabelBold ( int  )

◆ SetPointLabelItalic()

void vtkDataLabelRepresentation::SetPointLabelItalic ( int  )

◆ SetPointLabelShadow()

void vtkDataLabelRepresentation::SetPointLabelShadow ( int  )

◆ SetPointLabelJustification()

void vtkDataLabelRepresentation::SetPointLabelJustification ( int  )

◆ SetPointLabelFontSize()

void vtkDataLabelRepresentation::SetPointLabelFontSize ( int  )

◆ SetPointLabelFormat()

void vtkDataLabelRepresentation::SetPointLabelFormat ( const char *  )

◆ SetCellLabelVisibility()

void vtkDataLabelRepresentation::SetCellLabelVisibility ( int  )

◆ SetCellFieldDataArrayName()

void vtkDataLabelRepresentation::SetCellFieldDataArrayName ( const char *  )

◆ SetCellLabelMode()

void vtkDataLabelRepresentation::SetCellLabelMode ( int  )

◆ SetCellLabelColor()

void vtkDataLabelRepresentation::SetCellLabelColor ( double  r,
double  g,
double  b 
)

◆ SetCellLabelOpacity()

void vtkDataLabelRepresentation::SetCellLabelOpacity ( double  )

◆ SetCellLabelFontFamily()

void vtkDataLabelRepresentation::SetCellLabelFontFamily ( int  )

◆ SetCellLabelBold()

void vtkDataLabelRepresentation::SetCellLabelBold ( int  )

◆ SetCellLabelItalic()

void vtkDataLabelRepresentation::SetCellLabelItalic ( int  )

◆ SetCellLabelShadow()

void vtkDataLabelRepresentation::SetCellLabelShadow ( int  )

◆ SetCellLabelJustification()

void vtkDataLabelRepresentation::SetCellLabelJustification ( int  )

◆ SetCellLabelFontSize()

void vtkDataLabelRepresentation::SetCellLabelFontSize ( int  )

◆ SetCellLabelFormat()

void vtkDataLabelRepresentation::SetCellLabelFormat ( const char *  )

◆ SetOrientation()

void vtkDataLabelRepresentation::SetOrientation ( double  ,
double  ,
double   
)

Used to build the internal transform.

◆ SetOrigin()

void vtkDataLabelRepresentation::SetOrigin ( double  ,
double  ,
double   
)

Used to build the internal transform.

◆ SetPosition()

void vtkDataLabelRepresentation::SetPosition ( double  ,
double  ,
double   
)

Used to build the internal transform.

◆ SetScale()

void vtkDataLabelRepresentation::SetScale ( double  ,
double  ,
double   
)

Used to build the internal transform.

◆ SetUserTransform()

void vtkDataLabelRepresentation::SetUserTransform ( const double  [16])

Used to build the internal transform.

◆ ProcessViewRequest()

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

Reimplemented from vtkPVDataRepresentation.

◆ AddToView()

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

Adds the representation to the view.

This is called from vtkView::AddRepresentation(). Subclasses should override this method. Returns true if the addition succeeds.

Reimplemented from vtkPVDataRepresentation.

◆ RemoveFromView()

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

Removes the representation to the view.

This is called from vtkView::RemoveRepresentation(). Subclasses should override this method. Returns true if the removal succeeds.

Reimplemented from vtkPVDataRepresentation.

◆ FillInputPortInformation()

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

Fill input port information.

◆ RequestData()

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

Subclasses should override this to connect inputs to the internal pipeline as necessary.

Since most representations are "meta-filters" (i.e. filters containing other filters), you should create shallow copies of your input before connecting to the internal pipeline. The convenience method GetInternalOutputPort will create a cached shallow copy of a specified input for you. The related helper functions GetInternalAnnotationOutputPort, GetInternalSelectionOutputPort should be used to obtain a selection or annotation port whose selections are localized for a particular input data object.

Reimplemented from vtkPVDataRepresentation.

◆ IsCached()

virtual bool vtkDataLabelRepresentation::IsCached ( double  cache_key)
protectedvirtual

Overridden to check with the vtkPVCacheKeeper to see if the key is cached.

Reimplemented from vtkPVDataRepresentation.

◆ UpdateTransform()

void vtkDataLabelRepresentation::UpdateTransform ( )
protected

◆ OnWarningEvent()

static void vtkDataLabelRepresentation::OnWarningEvent ( vtkObject *  source,
unsigned  long,
void *  clientdata,
void *   
)
staticprotected

Member Data Documentation

◆ MergeBlocks

vtkCompositeDataToUnstructuredGridFilter* vtkDataLabelRepresentation::MergeBlocks
protected

Definition at line 163 of file vtkDataLabelRepresentation.h.

◆ CacheKeeper

vtkPVCacheKeeper* vtkDataLabelRepresentation::CacheKeeper
protected

Definition at line 164 of file vtkDataLabelRepresentation.h.

◆ PointLabelMapper

vtkLabeledDataMapper* vtkDataLabelRepresentation::PointLabelMapper
protected

Definition at line 166 of file vtkDataLabelRepresentation.h.

◆ PointLabelProperty

vtkTextProperty* vtkDataLabelRepresentation::PointLabelProperty
protected

Definition at line 167 of file vtkDataLabelRepresentation.h.

◆ PointLabelActor

vtkActor2D* vtkDataLabelRepresentation::PointLabelActor
protected

Definition at line 168 of file vtkDataLabelRepresentation.h.

◆ CellCenters

vtkCellCenters* vtkDataLabelRepresentation::CellCenters
protected

Definition at line 170 of file vtkDataLabelRepresentation.h.

◆ CellLabelMapper

vtkLabeledDataMapper* vtkDataLabelRepresentation::CellLabelMapper
protected

Definition at line 171 of file vtkDataLabelRepresentation.h.

◆ CellLabelProperty

vtkTextProperty* vtkDataLabelRepresentation::CellLabelProperty
protected

Definition at line 172 of file vtkDataLabelRepresentation.h.

◆ CellLabelActor

vtkActor2D* vtkDataLabelRepresentation::CellLabelActor
protected

Definition at line 173 of file vtkDataLabelRepresentation.h.

◆ TransformHelperProp

vtkProp3D* vtkDataLabelRepresentation::TransformHelperProp
protected

Definition at line 175 of file vtkDataLabelRepresentation.h.

◆ Transform

vtkTransform* vtkDataLabelRepresentation::Transform
protected

Definition at line 176 of file vtkDataLabelRepresentation.h.

◆ Dataset

vtkSmartPointer<vtkDataObject> vtkDataLabelRepresentation::Dataset
protected

Definition at line 178 of file vtkDataLabelRepresentation.h.

◆ WarningObserver

vtkCallbackCommand* vtkDataLabelRepresentation::WarningObserver
protected

Definition at line 181 of file vtkDataLabelRepresentation.h.

◆ PointLabelVisibility

int vtkDataLabelRepresentation::PointLabelVisibility
protected

Definition at line 184 of file vtkDataLabelRepresentation.h.

◆ CellLabelVisibility

int vtkDataLabelRepresentation::CellLabelVisibility
protected

Definition at line 185 of file vtkDataLabelRepresentation.h.


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