Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
207 lines (173 sloc) 7.22 KB
/*=========================================================================
Program: Visualization Toolkit
Module: vtkLegendBoxActor.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkLegendBoxActor - draw symbols with text
// .SECTION Description
// vtkLegendBoxActor is used to associate a symbol with a text string.
// The user specifies a vtkPolyData to use as the symbol, and a string
// associated with the symbol. The actor can then be placed in the scene
// in the same way that any other vtkActor2D can be used.
//
// To use this class, you must define the position of the legend box by using
// the superclasses' vtkActor2D::Position coordinate and
// Position2 coordinate. Then define the set of symbols and text strings that
// make up the menu box. The font attributes of the entries can be set through
// the vtkTextProperty associated to this actor. The class will
// scale the symbols and text to fit in the legend box defined by
// (Position,Position2). Optional features like turning on a border line and
// setting the spacing between the border and the symbols/text can also be
// set.
// .SECTION See Also
// vtkXYPlotActor vtkActor2D vtkGlyphSource2D
#ifndef __vtkLegendBoxActor_h
#define __vtkLegendBoxActor_h
#include "vtkActor2D.h"
class vtkActor;
class vtkDoubleArray;
class vtkPolyData;
class vtkPolyDataMapper2D;
class vtkPolyDataMapper;
class vtkTextMapper;
class vtkTextProperty;
class vtkTransform;
class vtkTransformPolyDataFilter;
class vtkProperty2D;
class VTK_HYBRID_EXPORT vtkLegendBoxActor : public vtkActor2D
{
public:
vtkTypeMacro(vtkLegendBoxActor,vtkActor2D);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Instantiate object with a rectangle in normaled view coordinates
// of (0.2,0.85, 0.8, 0.95).
static vtkLegendBoxActor *New();
// Description:
// Specify the number of entries in the legend box.
void SetNumberOfEntries(int num);
int GetNumberOfEntries()
{return this->NumberOfEntries;}
// Description:
// Add an entry to the legend box. You must supply a vtkPolyData to be
// used as a symbol (it can be NULL) and a text string (which also can
// be NULL). The vtkPolyData is assumed to be defined in the x-y plane,
// and the text is assumed to be a single line in height. Note that when
// this method is invoked previous entries are deleted. Also supply a text
// string and optionally a color. (If a color is not specified, then the
// entry color is the same as this actor's color.) (Note: use the set
// methods when you use SetNumberOfEntries().)
void SetEntry(int i, vtkPolyData *symbol, const char* string, double color[3]);
void SetEntrySymbol(int i, vtkPolyData *symbol);
void SetEntryString(int i, const char* string);
void SetEntryColor(int i, double color[3]);
void SetEntryColor(int i, double r, double g, double b);
vtkPolyData *GetEntrySymbol(int i);
const char* GetEntryString(int i);
double *GetEntryColor(int i);
// Description:
// Set/Get the text property.
virtual void SetEntryTextProperty(vtkTextProperty *p);
vtkGetObjectMacro(EntryTextProperty,vtkTextProperty);
// Description:
// Set/Get the flag that controls whether a border will be drawn
// around the legend box.
vtkSetMacro(Border, int);
vtkGetMacro(Border, int);
vtkBooleanMacro(Border, int);
// Description:
// Set/Get the flag that controls whether the border and legend
// placement is locked into the rectangle defined by (Position,Position2).
// If off, then the legend box will adjust its size so that the border
// fits nicely around the text and symbols. (The ivar is off by default.)
// Note: the legend box is guaranteed to lie within the original border
// definition.
vtkSetMacro(LockBorder, int);
vtkGetMacro(LockBorder, int);
vtkBooleanMacro(LockBorder, int);
// Description:
// Set/Get the flag that controls whether a box will be drawn/filled
// corresponding to the legend box.
vtkSetMacro(Box, int);
vtkGetMacro(Box, int);
vtkBooleanMacro(Box, int);
// Description:
// Get the box vtkProperty2D.
vtkProperty2D* GetBoxProperty() { return this->BoxActor->GetProperty(); };
// Description:
// Set/Get the padding between the legend entries and the border. The value
// is specified in pixels.
vtkSetClampMacro(Padding, int, 0, 50);
vtkGetMacro(Padding, int);
// Description:
// Turn on/off flag to control whether the symbol's scalar data
// is used to color the symbol. If off, the color of the
// vtkLegendBoxActor is used.
vtkSetMacro(ScalarVisibility,int);
vtkGetMacro(ScalarVisibility,int);
vtkBooleanMacro(ScalarVisibility,int);
// Description:
// Shallow copy of this scaled text actor. Overloads the virtual
// vtkProp method.
void ShallowCopy(vtkProp *prop);
//BTX
// Description:
// WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE
// DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
// Release any graphics resources that are being consumed by this actor.
// The parameter window could be used to determine which graphic
// resources to release.
virtual void ReleaseGraphicsResources(vtkWindow *);
// Description:
// WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE
// DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
// Draw the legend box to the screen.
int RenderOpaqueGeometry(vtkViewport* viewport);
virtual int RenderTranslucentPolygonalGeometry(vtkViewport* ) {return 0;};
int RenderOverlay(vtkViewport* viewport);
// Description:
// Does this prop have some translucent polygonal geometry?
virtual int HasTranslucentPolygonalGeometry();
//ETX
protected:
vtkLegendBoxActor();
~vtkLegendBoxActor();
void InitializeEntries();
int Border;
int Box;
int Padding;
int LockBorder;
int ScalarVisibility;
double BoxOpacity;
// Internal actors, mappers, data to represent the legend
int NumberOfEntries;
int Size; //allocation size
vtkDoubleArray *Colors;
vtkTextMapper **TextMapper;
vtkActor2D **TextActor;
vtkPolyData **Symbol;
vtkTransform **Transform;
vtkTransformPolyDataFilter **SymbolTransform;
vtkPolyDataMapper2D **SymbolMapper;
vtkActor2D **SymbolActor;
vtkPolyData *BorderPolyData;
vtkPolyDataMapper2D *BorderMapper;
vtkActor2D *BorderActor;
vtkPolyData *BoxPolyData;
vtkPolyDataMapper2D *BoxMapper;
vtkActor2D *BoxActor;
vtkTextProperty *EntryTextProperty;
// Used to control whether the stuff is recomputed
int LegendEntriesVisible;
int CachedSize[2];
vtkTimeStamp BuildTime;
private:
vtkLegendBoxActor(const vtkLegendBoxActor&); // Not implemented.
void operator=(const vtkLegendBoxActor&); // Not implemented.
};
#endif
Something went wrong with that request. Please try again.