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
vtkColorLegend Class Reference

Legend item to display vtkScalarsToColors. More...

#include <vtkColorLegend.h>

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

Public Types

typedef vtkChartLegend Superclass
 
- Public Types inherited from vtkChartLegend
enum  {
  LEFT = 0, CENTER, RIGHT, TOP,
  BOTTOM, CUSTOM
}
 
typedef vtkContextItem Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkColorLegendNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void GetBounds (double bounds[4])
 
virtual void Update ()
 
virtual bool Paint (vtkContext2D *painter)
 
virtual void SetTransferFunction (vtkScalarsToColors *transfer)
 
virtual vtkScalarsToColorsGetTransferFunction ()
 
virtual void SetPosition (const vtkRectf &pos)
 
virtual vtkRectf GetPosition ()
 
vtkRectf GetBoundingRect (vtkContext2D *painter)
 
- Public Member Functions inherited from vtkChartLegend
vtkChartLegendNewInstance () const
 
void SetPoint (const vtkVector2f &point)
 
const vtkVector2f & GetPointVector ()
 
virtual void SetLabelSize (int size)
 
virtual int GetLabelSize ()
 
void SetChart (vtkChart *chart)
 
vtkChartGetChart ()
 
vtkPen * GetPen ()
 
vtkBrush * GetBrush ()
 
vtkTextProperty * GetLabelProperties ()
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 
virtual void SetPoint (float, float)
 
void SetPoint (float[2])
 
virtual float * GetPoint ()
 
virtual void GetPoint (float &, float &)
 
virtual void GetPoint (float[2])
 
virtual void SetHorizontalAlignment (int)
 
virtual int GetHorizontalAlignment ()
 
virtual void SetVerticalAlignment (int)
 
virtual int GetVerticalAlignment ()
 
virtual void SetPadding (int)
 
virtual int GetPadding ()
 
virtual void SetSymbolWidth (int)
 
virtual int GetSymbolWidth ()
 
virtual void SetInline (bool)
 
virtual bool GetInline ()
 
virtual void SetDragEnabled (bool)
 
virtual bool GetDragEnabled ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkColorLegendSafeDownCast (vtkObjectBase *o)
 
static vtkColorLegendNew ()
 
- Static Public Member Functions inherited from vtkChartLegend
static int IsTypeOf (const char *type)
 
static vtkChartLegendSafeDownCast (vtkObjectBase *o)
 
static vtkChartLegendNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkColorLegend ()
 
virtual ~vtkColorLegend ()
 
virtual void ComputeTexture ()
 
- Protected Member Functions inherited from vtkChartLegend
 vtkChartLegend ()
 
 ~vtkChartLegend ()
 

Protected Attributes

vtkScalarsToColorsTransferFunction
 
vtkSmartPointer< vtkImageData > ImageData
 
vtkSmartPointer< vtkAxisAxis
 
vtkSmartPointer
< vtkCallbackCommand
Callback
 
bool Interpolate
 
vtkRectf Position
 
- Protected Attributes inherited from vtkChartLegend
float * Point
 
int HorizontalAlignment
 
int VerticalAlignment
 
vtkNew< vtkPen > Pen
 
vtkNew< vtkBrush > Brush
 
vtkNew< vtkTextProperty > LabelProperties
 
bool DragEnabled
 
int Button
 
vtkTimeStamp PlotTime
 
vtkTimeStamp RectTime
 
vtkRectf Rect
 
int Padding
 
int SymbolWidth
 
bool Inline
 
Private * Storage
 
virtual void ScalarsToColorsModified (vtkObject *caller, unsigned long eid, void *calldata)
 
static void OnScalarsToColorsModified (vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)
 

Detailed Description

Legend item to display vtkScalarsToColors.

vtkColorLegend is an item that will display the vtkScalarsToColors using a 1D texture, and a vtkAxis to show both the color and numerical range.

Definition at line 36 of file vtkColorLegend.h.

Member Typedef Documentation

Definition at line 39 of file vtkColorLegend.h.

Constructor & Destructor Documentation

vtkColorLegend::vtkColorLegend ( )
protected
virtual vtkColorLegend::~vtkColorLegend ( )
protectedvirtual

Member Function Documentation

static int vtkColorLegend::IsTypeOf ( const char *  type)
static
virtual int vtkColorLegend::IsA ( const char *  type)
virtual

Reimplemented from vtkChartLegend.

static vtkColorLegend* vtkColorLegend::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkColorLegend::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkChartLegend.

vtkColorLegend* vtkColorLegend::NewInstance ( ) const
virtual void vtkColorLegend::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Reimplemented from vtkChartLegend.

static vtkColorLegend* vtkColorLegend::New ( )
static
virtual void vtkColorLegend::GetBounds ( double  bounds[4])
virtual

Bounds of the item, by default (0, 1, 0, 1) but it mainly depends on the range of the vtkScalarsToColors function.

virtual void vtkColorLegend::Update ( )
virtual

Perform any updates to the item that may be necessary before rendering. The scene should take care of calling this on all items before their Paint function is invoked.

Reimplemented from vtkChartLegend.

virtual bool vtkColorLegend::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 vtkChartLegend.

virtual void vtkColorLegend::SetTransferFunction ( vtkScalarsToColors transfer)
virtual
virtual vtkScalarsToColors* vtkColorLegend::GetTransferFunction ( )
virtual
virtual void vtkColorLegend::SetPosition ( const vtkRectf &  pos)
virtual
virtual vtkRectf vtkColorLegend::GetPosition ( )
virtual
vtkRectf vtkColorLegend::GetBoundingRect ( vtkContext2D *  painter)
virtual

Request the space the legend requires to be drawn. This is returned as a vtkRect4f, with the corner being the offset from Point, and the width/ height being the total width/height required by the axis. In order to ensure the numbers are correct, Update() should be called first.

Reimplemented from vtkChartLegend.

virtual void vtkColorLegend::ComputeTexture ( )
protectedvirtual

Need to be reimplemented by subclasses, ComputeTexture() is called at paint time if the texture is not up to date compared to vtkColorLegend

virtual void vtkColorLegend::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 vtkColorLegend::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

vtkScalarsToColors* vtkColorLegend::TransferFunction
protected

Definition at line 88 of file vtkColorLegend.h.

vtkSmartPointer<vtkImageData> vtkColorLegend::ImageData
protected

Definition at line 89 of file vtkColorLegend.h.

vtkSmartPointer<vtkAxis> vtkColorLegend::Axis
protected

Definition at line 90 of file vtkColorLegend.h.

vtkSmartPointer<vtkCallbackCommand> vtkColorLegend::Callback
protected

Definition at line 91 of file vtkColorLegend.h.

bool vtkColorLegend::Interpolate
protected

Definition at line 92 of file vtkColorLegend.h.

vtkRectf vtkColorLegend::Position
protected

Definition at line 93 of file vtkColorLegend.h.


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