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

custom version of vtkDiscretizableColorTransferFunction that adds some functionality. More...

#include <vtkPVDiscretizableColorTransferFunction.h>

Inherits vtkDiscretizableColorTransferFunction.

Public Types

typedef vtkDiscretizableColorTransferFunction Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ResetActiveAnnotatedValues ()
 
void SetActiveAnnotatedValue (vtkStdString value)
 
void SetNumberOfIndexedColorsInFullSet (int n)
 
int GetNumberOfIndexedColorsInFullSet ()
 
void SetIndexedColorInFullSet (unsigned int index, double r, double g, double b)
 
void GetIndexedColorInFullSet (unsigned int index, double rgb[3])
 
virtual void Build ()
 Override to set only the active annotations. More...
 
virtual void SetAnnotationsInFullSet (vtkAbstractArray *values, vtkStringArray *annotations)
 Parallel API to API for annotated values to set/get the full list of annotations. More...
 
virtual vtkAbstractArray * GetAnnotatedValuesInFullSet ()
 Parallel API to API for annotated values to set/get the full list of annotations. More...
 
virtual vtkStringArray * GetAnnotationsInFullSet ()
 Parallel API to API for annotated values to set/get the full list of annotations. More...
 
virtual vtkIdType SetAnnotationInFullSet (vtkVariant value, vtkStdString annotation)
 Parallel API to API for annotated values to set/get the full list of annotations. More...
 
virtual vtkIdType SetAnnotationInFullSet (vtkStdString value, vtkStdString annotation)
 Parallel API to API for annotated values to set/get the full list of annotations. More...
 
virtual void ResetAnnotationsInFullSet ()
 Parallel API to API for annotated values to set/get the full list of annotations. More...
 
virtual void SetUseActiveValues (bool)
 Set whether to use restrict annotations to only the values designated as active. More...
 
virtual bool GetUseActiveValues ()
 Set whether to use restrict annotations to only the values designated as active. More...
 
virtual void UseActiveValuesOn ()
 Set whether to use restrict annotations to only the values designated as active. More...
 
virtual void UseActiveValuesOff ()
 Set whether to use restrict annotations to only the values designated as active. More...
 

Static Public Member Functions

static vtkPVDiscretizableColorTransferFunctionNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVDiscretizableColorTransferFunctionSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVDiscretizableColorTransferFunction ()
 
 ~vtkPVDiscretizableColorTransferFunction ()
 

Detailed Description

custom version of vtkDiscretizableColorTransferFunction that adds some functionality.

This class is the same as vtkDiscretizableColorTransferFunction, but it adds the concept of "active" annotations. These annotations are a subset of the full list of annotations available and are used in place of the full annotation list.

Definition at line 37 of file vtkPVDiscretizableColorTransferFunction.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDiscretizableColorTransferFunction vtkPVDiscretizableColorTransferFunction::Superclass

Definition at line 42 of file vtkPVDiscretizableColorTransferFunction.h.

Constructor & Destructor Documentation

◆ vtkPVDiscretizableColorTransferFunction()

vtkPVDiscretizableColorTransferFunction::vtkPVDiscretizableColorTransferFunction ( )
protected

◆ ~vtkPVDiscretizableColorTransferFunction()

vtkPVDiscretizableColorTransferFunction::~vtkPVDiscretizableColorTransferFunction ( )
protected

Member Function Documentation

◆ New()

static vtkPVDiscretizableColorTransferFunction* vtkPVDiscretizableColorTransferFunction::New ( )
static

◆ GetClassName()

virtual const char* vtkPVDiscretizableColorTransferFunction::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetAnnotationsInFullSet()

virtual void vtkPVDiscretizableColorTransferFunction::SetAnnotationsInFullSet ( vtkAbstractArray *  values,
vtkStringArray *  annotations 
)
virtual

Parallel API to API for annotated values to set/get the full list of annotations.

A subset of the full list will be used.

◆ GetAnnotatedValuesInFullSet()

virtual vtkAbstractArray* vtkPVDiscretizableColorTransferFunction::GetAnnotatedValuesInFullSet ( )
virtual

Parallel API to API for annotated values to set/get the full list of annotations.

A subset of the full list will be used.

◆ GetAnnotationsInFullSet()

virtual vtkStringArray* vtkPVDiscretizableColorTransferFunction::GetAnnotationsInFullSet ( )
virtual

Parallel API to API for annotated values to set/get the full list of annotations.

A subset of the full list will be used.

◆ SetAnnotationInFullSet() [1/2]

virtual vtkIdType vtkPVDiscretizableColorTransferFunction::SetAnnotationInFullSet ( vtkVariant  value,
vtkStdString  annotation 
)
virtual

Parallel API to API for annotated values to set/get the full list of annotations.

A subset of the full list will be used.

◆ SetAnnotationInFullSet() [2/2]

virtual vtkIdType vtkPVDiscretizableColorTransferFunction::SetAnnotationInFullSet ( vtkStdString  value,
vtkStdString  annotation 
)
virtual

Parallel API to API for annotated values to set/get the full list of annotations.

A subset of the full list will be used.

◆ ResetAnnotationsInFullSet()

virtual void vtkPVDiscretizableColorTransferFunction::ResetAnnotationsInFullSet ( )
virtual

Parallel API to API for annotated values to set/get the full list of annotations.

A subset of the full list will be used.

◆ ResetActiveAnnotatedValues()

void vtkPVDiscretizableColorTransferFunction::ResetActiveAnnotatedValues ( )

◆ SetActiveAnnotatedValue()

void vtkPVDiscretizableColorTransferFunction::SetActiveAnnotatedValue ( vtkStdString  value)

◆ SetNumberOfIndexedColorsInFullSet()

void vtkPVDiscretizableColorTransferFunction::SetNumberOfIndexedColorsInFullSet ( int  n)

◆ GetNumberOfIndexedColorsInFullSet()

int vtkPVDiscretizableColorTransferFunction::GetNumberOfIndexedColorsInFullSet ( )

◆ SetIndexedColorInFullSet()

void vtkPVDiscretizableColorTransferFunction::SetIndexedColorInFullSet ( unsigned int  index,
double  r,
double  g,
double  b 
)

◆ GetIndexedColorInFullSet()

void vtkPVDiscretizableColorTransferFunction::GetIndexedColorInFullSet ( unsigned int  index,
double  rgb[3] 
)

◆ SetUseActiveValues()

virtual void vtkPVDiscretizableColorTransferFunction::SetUseActiveValues ( bool  )
virtual

Set whether to use restrict annotations to only the values designated as active.

Off by default.

◆ GetUseActiveValues()

virtual bool vtkPVDiscretizableColorTransferFunction::GetUseActiveValues ( )
virtual

Set whether to use restrict annotations to only the values designated as active.

Off by default.

◆ UseActiveValuesOn()

virtual void vtkPVDiscretizableColorTransferFunction::UseActiveValuesOn ( )
virtual

Set whether to use restrict annotations to only the values designated as active.

Off by default.

◆ UseActiveValuesOff()

virtual void vtkPVDiscretizableColorTransferFunction::UseActiveValuesOff ( )
virtual

Set whether to use restrict annotations to only the values designated as active.

Off by default.

◆ Build()

virtual void vtkPVDiscretizableColorTransferFunction::Build ( )
virtual

Override to set only the active annotations.


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