VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkScalarsToColorsItem Class Reference

Abstract class for ScalarsToColors items. More...

#include <vtkScalarsToColorsItem.h>

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

List of all members.

Public Types

typedef vtkPlot 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 doubleGetUserBounds ()
virtual void GetUserBounds (double &, double &, double &, double &)
virtual void GetUserBounds (double[4])
virtual vtkPenGetPolyLinePen ()
virtual void SetMaskAboveCurve (bool)
virtual bool GetMaskAboveCurve ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkScalarsToColorsItemSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkScalarsToColorsItem ()
virtual ~vtkScalarsToColorsItem ()
virtual void ComputeBounds (double *bounds)
virtual void ComputeTexture ()=0
virtual int GetTextureWidth ()

Protected Attributes

double UserBounds [4]
int TextureWidth
vtkImageDataTexture
bool Interpolate
vtkPoints2DShape
vtkCallbackCommandCallback
vtkPenPolyLinePen
bool MaskAboveCurve
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


Constructor & Destructor Documentation

virtual vtkScalarsToColorsItem::~vtkScalarsToColorsItem ( ) [protected, virtual]

Member Function Documentation

static int vtkScalarsToColorsItem::IsTypeOf ( const char *  name) [static]

Return 1 if this class type 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 vtkPlot.

Reimplemented in vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

virtual int vtkScalarsToColorsItem::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 vtkPlot.

Reimplemented in vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

virtual vtkObjectBase* vtkScalarsToColorsItem::NewInstanceInternal ( ) const [protected, virtual]
virtual void vtkScalarsToColorsItem::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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 vtkPlot.

Reimplemented in vtkColorTransferFunctionItem, vtkLookupTableItem, vtkCompositeTransferFunctionItem, and vtkPiecewiseFunctionItem.

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.

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

Reimplemented from vtkAbstractContextItem.

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) [protected, virtual]

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 ( ) [protected, pure 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, vtkCompositeTransferFunctionItem, vtkLookupTableItem, and vtkPiecewiseFunctionItem.

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

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 
) [static, protected]

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


Member Data Documentation

Definition at line 102 of file vtkScalarsToColorsItem.h.

Definition at line 104 of file vtkScalarsToColorsItem.h.

Definition at line 105 of file vtkScalarsToColorsItem.h.

Definition at line 106 of file vtkScalarsToColorsItem.h.

Definition at line 107 of file vtkScalarsToColorsItem.h.

Definition at line 108 of file vtkScalarsToColorsItem.h.

Definition at line 110 of file vtkScalarsToColorsItem.h.

Definition at line 111 of file vtkScalarsToColorsItem.h.


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