VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkScalarsToColorsItem Class Referenceabstract

Abstract class for ScalarsToColors items. More...

#include <vtkScalarsToColorsItem.h>

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

Public Types

typedef vtkPlot Superclass
 
- Public Types inherited from vtkPlot
typedef vtkContextItem Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkScalarsToColorsItemNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
void GetBounds (double bounds[4])
 
virtual bool Paint (vtkContext2D *painter)
 
virtual void SetUserBounds (double, double, double, double)
 
virtual void SetUserBounds (double[4])
 
virtual double * GetUserBounds ()
 
virtual void GetUserBounds (double &, double &, double &, double &)
 
virtual void GetUserBounds (double[4])
 
virtual vtkPen * GetPolyLinePen ()
 
virtual void SetMaskAboveCurve (bool)
 
virtual bool GetMaskAboveCurve ()
 
- Public Member Functions inherited from vtkPlot
vtkPlotNewInstance () const
 
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
 
virtual void SetWidth (float width)
 
virtual float GetWidth ()
 
virtual void SetLabel (const vtkStdString &label)
 
virtual vtkStdString GetLabel ()
 
virtual void SetLabels (vtkStringArray *labels)
 
virtual vtkStringArrayGetLabels ()
 
virtual int GetNumberOfLabels ()
 
vtkStdString GetLabel (vtkIdType index)
 
void SetIndexedLabels (vtkStringArray *labels)
 
virtual vtkStringArrayGetIndexedLabels ()
 
vtkContextMapper2D * GetData ()
 
virtual vtkTable * GetInput ()
 
virtual void SetInputArray (int index, const vtkStdString &name)
 
virtual void SetSelection (vtkIdTypeArray *id)
 
virtual vtkIdTypeArrayGetSelection ()
 
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
 
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 
virtual vtkStdString GetTooltipLabelFormat ()
 
virtual void SetTooltipNotation (int notation)
 
virtual int GetTooltipNotation ()
 
virtual void SetTooltipPrecision (int precision)
 
virtual int GetTooltipPrecision ()
 
virtual vtkStdString GetTooltipLabel (const vtkVector2f &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
 
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
 
virtual bool SelectPointsInPolygon (const vtkContextPolygon &polygon)
 
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 
virtual void SetColor (double r, double g, double b)
 
virtual void GetColor (double rgb[3])
 
void GetColor (unsigned char rgb[3])
 
void SetPen (vtkPen *pen)
 
vtkPen * GetPen ()
 
void SetBrush (vtkBrush *brush)
 
vtkBrush * GetBrush ()
 
virtual bool GetUseIndexForXSeries ()
 
virtual void SetUseIndexForXSeries (bool)
 
virtual void SetInputData (vtkTable *table)
 
virtual void SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
 
void SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
 
virtual vtkAxisGetXAxis ()
 
virtual void SetXAxis (vtkAxis *axis)
 
virtual vtkAxisGetYAxis ()
 
virtual void SetYAxis (vtkAxis *axis)
 
virtual void GetUnscaledInputBounds (double bounds[4])
 
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 
virtual vtkVariant GetProperty (const vtkStdString &property)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkScalarsToColorsItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPlot
static int IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkScalarsToColorsItem ()
 
virtual ~vtkScalarsToColorsItem ()
 
virtual void ComputeBounds (double *bounds)
 
virtual void ComputeTexture ()=0
 
virtual int GetTextureWidth ()
 
- Protected Member Functions inherited from vtkPlot
 vtkPlot ()
 
 ~vtkPlot ()
 
vtkStdString GetNumber (double position, vtkAxis *axis)
 

Protected Attributes

double UserBounds [4]
 
int TextureWidth
 
vtkImageData * Texture
 
bool Interpolate
 
vtkPoints2DShape
 
vtkCallbackCommandCallback
 
vtkPen * PolyLinePen
 
bool MaskAboveCurve
 
- Protected Attributes inherited from vtkPlot
vtkSmartPointer< vtkPen > Pen
 
vtkSmartPointer< vtkBrush > Brush
 
vtkSmartPointer< vtkStringArrayLabels
 
vtkSmartPointer< vtkStringArrayAutoLabels
 
vtkSmartPointer< vtkStringArrayIndexedLabels
 
bool UseIndexForXSeries
 
vtkSmartPointer
< vtkContextMapper2D > 
Data
 
vtkIdTypeArraySelection
 
vtkAxisXAxis
 
vtkAxisYAxis
 
vtkStdString TooltipLabelFormat
 
vtkStdString TooltipDefaultLabelFormat
 
int TooltipNotation
 
int TooltipPrecision
 
virtual void ScalarsToColorsModified (vtkObject *caller, unsigned long eid, void *calldata)
 
static void OnScalarsToColorsModified (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 

Detailed Description

Abstract class for ScalarsToColors items.

vtkScalarsToColorsItem implements item bounds and painting for inherited classes that provide a texture (ComputeTexture()) and optionally a shape

See Also
vtkControlPointsItem vtkLookupTableItem vtkColorTransferFunctionItem vtkCompositeTransferFunctionItem vtkPiecewiseItemFunctionItem

Definition at line 39 of file vtkScalarsToColorsItem.h.

Member Typedef Documentation

Definition at line 42 of file vtkScalarsToColorsItem.h.

Constructor & Destructor Documentation

vtkScalarsToColorsItem::vtkScalarsToColorsItem ( )
protected
virtual vtkScalarsToColorsItem::~vtkScalarsToColorsItem ( )
protectedvirtual

Member Function Documentation

static int vtkScalarsToColorsItem::IsTypeOf ( const char *  type)
static
virtual int vtkScalarsToColorsItem::IsA ( const char *  type)
virtual
static vtkScalarsToColorsItem* vtkScalarsToColorsItem::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkScalarsToColorsItem::NewInstanceInternal ( ) const
protectedvirtual
vtkScalarsToColorsItem* vtkScalarsToColorsItem::NewInstance ( ) const
virtual void vtkScalarsToColorsItem::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
void vtkScalarsToColorsItem::GetBounds ( double  bounds[4])
virtual

Bounds of the item, use the UserBounds if valid otherwise compute the bounds of the item (based on the transfer function range).

Reimplemented from vtkPlot.

virtual void vtkScalarsToColorsItem::SetUserBounds ( double  ,
double  ,
double  ,
double   
)
virtual

Set custom bounds, except if bounds are invalid, bounds will be automatically computed based on the range of the control points Invalid bounds by default.

virtual void vtkScalarsToColorsItem::SetUserBounds ( double  [4])
virtual

Set custom bounds, except if bounds are invalid, bounds will be automatically computed based on the range of the control points Invalid bounds by default.

virtual double* vtkScalarsToColorsItem::GetUserBounds ( )
virtual

Set custom bounds, except if bounds are invalid, bounds will be automatically computed based on the range of the control points Invalid bounds by default.

virtual void vtkScalarsToColorsItem::GetUserBounds ( double &  ,
double &  ,
double &  ,
double &   
)
virtual

Set custom bounds, except if bounds are invalid, bounds will be automatically computed based on the range of the control points Invalid bounds by default.

virtual void vtkScalarsToColorsItem::GetUserBounds ( double  [4])
virtual

Set custom bounds, except if bounds are invalid, bounds will be automatically computed based on the range of the control points Invalid bounds by default.

virtual bool vtkScalarsToColorsItem::Paint ( vtkContext2D *  painter)
virtual

Paint the texture into a rectangle defined by the bounds. If MaskAboveCurve is true and a shape has been provided by a subclass, it draws the texture into the shape

virtual vtkPen* vtkScalarsToColorsItem::GetPolyLinePen ( )
virtual

Get a pointer to the vtkPen object that controls the drawing of the edge of the shape if any. PolyLinePen type is vtkPen::NO_PEN by default.

virtual void vtkScalarsToColorsItem::SetMaskAboveCurve ( bool  )
virtual

Don't fill in the part above the transfer function. If true texture is not visible above the shape provided by subclasses, otherwise the whole rectangle defined by the bounds is filled with the transfer function. Note: only 2D transfer functions (RGB tf + alpha tf ) support the feature.

virtual bool vtkScalarsToColorsItem::GetMaskAboveCurve ( )
virtual

Don't fill in the part above the transfer function. If true texture is not visible above the shape provided by subclasses, otherwise the whole rectangle defined by the bounds is filled with the transfer function. Note: only 2D transfer functions (RGB tf + alpha tf ) support the feature.

virtual void vtkScalarsToColorsItem::ComputeBounds ( double *  bounds)
protectedvirtual

Bounds of the item, by default (0, 1, 0, 1) but it depends on the range of the ScalarsToColors function. Need to be reimplemented by subclasses if the range is != [0,1]

virtual void vtkScalarsToColorsItem::ComputeTexture ( )
protectedpure virtual

Need to be reimplemented by subclasses, ComputeTexture() is called at paint time if the texture is not up to date compared to vtkScalarsToColorsItem Return false if no texture is generated.

Implemented in vtkColorTransferFunctionItem, vtkLookupTableItem, vtkPiecewiseFunctionItem, and vtkCompositeTransferFunctionItem.

virtual int vtkScalarsToColorsItem::GetTextureWidth ( )
protectedvirtual
virtual void vtkScalarsToColorsItem::ScalarsToColorsModified ( vtkObject caller,
unsigned long  eid,
void *  calldata 
)
protectedvirtual

Called whenever the ScalarsToColors function(s) is modified. It internally calls Modified(). Can be reimplemented by subclasses

static void vtkScalarsToColorsItem::OnScalarsToColorsModified ( vtkObject caller,
unsigned long  eid,
void *  clientdata,
void *  calldata 
)
staticprotected

Called whenever the ScalarsToColors function(s) is modified. It internally calls Modified(). Can be reimplemented by subclasses

Member Data Documentation

double vtkScalarsToColorsItem::UserBounds[4]
protected

Definition at line 102 of file vtkScalarsToColorsItem.h.

int vtkScalarsToColorsItem::TextureWidth
protected

Definition at line 104 of file vtkScalarsToColorsItem.h.

vtkImageData* vtkScalarsToColorsItem::Texture
protected

Definition at line 105 of file vtkScalarsToColorsItem.h.

bool vtkScalarsToColorsItem::Interpolate
protected

Definition at line 106 of file vtkScalarsToColorsItem.h.

vtkPoints2D* vtkScalarsToColorsItem::Shape
protected

Definition at line 107 of file vtkScalarsToColorsItem.h.

vtkCallbackCommand* vtkScalarsToColorsItem::Callback
protected

Definition at line 108 of file vtkScalarsToColorsItem.h.

vtkPen* vtkScalarsToColorsItem::PolyLinePen
protected

Definition at line 110 of file vtkScalarsToColorsItem.h.

bool vtkScalarsToColorsItem::MaskAboveCurve
protected

Definition at line 111 of file vtkScalarsToColorsItem.h.


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