VTK
|
Create a scalar bar with labels. More...
#include <vtkScalarBarActor.h>
Public Types | |
enum | { PrecedeScalarBar = 0, SucceedScalarBar } |
typedef vtkActor2D | Superclass |
![]() | |
typedef vtkProp | Superclass |
![]() | |
typedef vtkObject | Superclass |
![]() | |
typedef vtkObjectBase | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual int | HasTranslucentPolygonalGeometry () |
virtual void | ReleaseGraphicsResources (vtkWindow *) |
void | ShallowCopy (vtkProp *prop) |
int | RenderOpaqueGeometry (vtkViewport *viewport) |
virtual int | RenderTranslucentPolygonalGeometry (vtkViewport *) |
int | RenderOverlay (vtkViewport *viewport) |
virtual void | SetLookupTable (vtkScalarsToColors *) |
virtual vtkScalarsToColors * | GetLookupTable () |
virtual void | SetUseOpacity (int) |
virtual int | GetUseOpacity () |
virtual void | UseOpacityOn () |
virtual void | UseOpacityOff () |
virtual void | SetMaximumNumberOfColors (int) |
virtual int | GetMaximumNumberOfColors () |
virtual void | SetNumberOfLabels (int) |
virtual int | GetNumberOfLabels () |
virtual void | SetOrientation (int) |
virtual int | GetOrientation () |
void | SetOrientationToHorizontal () |
void | SetOrientationToVertical () |
virtual void | SetTitleTextProperty (vtkTextProperty *p) |
virtual vtkTextProperty * | GetTitleTextProperty () |
virtual void | SetLabelTextProperty (vtkTextProperty *p) |
virtual vtkTextProperty * | GetLabelTextProperty () |
virtual void | SetLabelFormat (const char *) |
virtual char * | GetLabelFormat () |
virtual void | SetTitle (const char *) |
virtual char * | GetTitle () |
virtual void | SetComponentTitle (const char *) |
virtual char * | GetComponentTitle () |
virtual void | SetTextureGridWidth (double) |
virtual double | GetTextureGridWidth () |
virtual vtkActor2D * | GetTextureActor () |
virtual void | SetTextPosition (int) |
virtual int | GetTextPosition () |
virtual void | SetTextPositionToPrecedeScalarBar () |
virtual void | SetTextPositionToSucceedScalarBar () |
virtual void | SetMaximumWidthInPixels (int) |
virtual int | GetMaximumWidthInPixels () |
virtual void | SetMaximumHeightInPixels (int) |
virtual int | GetMaximumHeightInPixels () |
![]() | |
vtkProperty2D * | GetProperty () |
virtual void | SetProperty (vtkProperty2D *) |
void | SetDisplayPosition (int, int) |
virtual unsigned long | GetMTime () |
virtual void | GetActors2D (vtkPropCollection *pc) |
virtual void | SetMapper (vtkMapper2D *mapper) |
virtual vtkMapper2D * | GetMapper () |
virtual void | SetLayerNumber (int) |
virtual int | GetLayerNumber () |
virtual vtkCoordinate * | GetPositionCoordinate () |
virtual void | SetPosition (float x[2]) |
virtual void | SetPosition (float x, float y) |
virtual float * | GetPosition () |
virtual vtkCoordinate * | GetPosition2Coordinate () |
virtual void | SetPosition2 (float x[2]) |
virtual void | SetPosition2 (float x, float y) |
virtual float * | GetPosition2 () |
void | SetWidth (double w) |
double | GetWidth () |
void | SetHeight (double h) |
double | GetHeight () |
virtual vtkCoordinate * | GetActualPositionCoordinate (void) |
virtual vtkCoordinate * | GetActualPosition2Coordinate (void) |
![]() | |
virtual void | Pick () |
virtual unsigned long | GetRedrawMTime () |
virtual double * | GetBounds () |
virtual bool | HasKeys (vtkInformation *requiredKeys) |
virtual void | BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path) |
virtual void | GetActors (vtkPropCollection *) |
virtual void | GetVolumes (vtkPropCollection *) |
virtual void | SetVisibility (int) |
virtual int | GetVisibility () |
virtual void | VisibilityOn () |
virtual void | VisibilityOff () |
virtual void | SetPickable (int) |
virtual int | GetPickable () |
virtual void | PickableOn () |
virtual void | PickableOff () |
virtual void | SetDragable (int) |
virtual int | GetDragable () |
virtual void | DragableOn () |
virtual void | DragableOff () |
virtual void | SetUseBounds (bool) |
virtual bool | GetUseBounds () |
virtual void | UseBoundsOn () |
virtual void | UseBoundsOff () |
virtual void | InitPathTraversal () |
virtual vtkAssemblyPath * | GetNextPath () |
virtual int | GetNumberOfPaths () |
virtual void | PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix)) |
virtual vtkMatrix4x4 * | GetMatrix () |
virtual vtkInformation * | GetPropertyKeys () |
virtual void | SetPropertyKeys (vtkInformation *keys) |
virtual int | RenderVolumetricGeometry (vtkViewport *) |
virtual bool | RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
virtual bool | RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
virtual bool | RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
virtual bool | RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys) |
virtual double | GetEstimatedRenderTime (vtkViewport *) |
virtual double | GetEstimatedRenderTime () |
virtual void | SetEstimatedRenderTime (double t) |
virtual void | RestoreEstimatedRenderTime () |
virtual void | AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp)) |
virtual void | SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v)) |
virtual double | GetAllocatedRenderTime () |
void | SetRenderTimeMultiplier (double t) |
virtual double | GetRenderTimeMultiplier () |
virtual bool | GetSupportsSelection () |
virtual int | GetNumberOfConsumers () |
void | AddConsumer (vtkObject *c) |
void | RemoveConsumer (vtkObject *c) |
vtkObject * | GetConsumer (int i) |
int | IsConsumer (vtkObject *c) |
![]() | |
virtual void | DebugOn () |
virtual void | DebugOff () |
unsigned char | GetDebug () |
void | SetDebug (unsigned char debugFlag) |
virtual void | Modified () |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
int | HasObserver (unsigned long event, vtkCommand *) |
int | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
int | HasObserver (unsigned long event) |
int | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
int | InvokeEvent (unsigned long event, void *callData) |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
const char * | GetClassName () const |
virtual void | Delete () |
virtual void | FastDelete () |
void | Print (ostream &os) |
virtual void | Register (vtkObjectBase *o) |
virtual void | UnRegister (vtkObjectBase *o) |
void | SetReferenceCount (int) |
void | PrintRevisions (ostream &os) |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkScalarBarActor * | SafeDownCast (vtkObject *o) |
static vtkScalarBarActor * | New () |
Protected Member Functions | |
vtkScalarBarActor () | |
~vtkScalarBarActor () | |
virtual void | AllocateAndSizeLabels (int *labelSize, int *size, vtkViewport *viewport, double *range) |
virtual void | SizeTitle (int *titleSize, int *size, vtkViewport *viewport) |
![]() | |
vtkActor2D () | |
~vtkActor2D () | |
![]() | |
vtkProp () | |
~vtkProp () | |
![]() | |
vtkObject () | |
virtual | ~vtkObject () |
virtual void | RegisterInternal (vtkObjectBase *, int check) |
virtual void | UnRegisterInternal (vtkObjectBase *, int check) |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
void | InternalReleaseFocus () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &os) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Create a scalar bar with labels.
vtkScalarBarActor creates a scalar bar with annotation text. A scalar bar is a legend that indicates to the viewer the correspondence between color value and data value. The legend consists of a rectangular bar made of rectangular pieces each colored a constant value. Since vtkScalarBarActor is a subclass of vtkActor2D, it is drawn in the image plane (i.e., in the renderer's viewport) on top of the 3D graphics window.
To use vtkScalarBarActor you must associate a vtkScalarsToColors (or subclass) with it. The lookup table defines the colors and the range of scalar values used to map scalar data. Typically, the number of colors shown in the scalar bar is not equal to the number of colors in the lookup table, in which case sampling of the lookup table is performed.
Other optional capabilities include specifying the fraction of the viewport size (both x and y directions) which will control the size of the scalar bar and the number of annotation labels. The actual position of the scalar bar on the screen is controlled by using the vtkActor2D::SetPosition() method (by default the scalar bar is centered in the viewport). Other features include the ability to orient the scalar bar horizontally of vertically and controlling the format (printf style) with which to print the labels on the scalar bar. Also, the vtkScalarBarActor's property is applied to the scalar bar and annotation (including layer, and compositing operator).
Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated to this actor.
Definition at line 73 of file vtkScalarBarActor.h.
Definition at line 76 of file vtkScalarBarActor.h.
anonymous enum |
Definition at line 187 of file vtkScalarBarActor.h.
|
protected |
|
protected |
|
virtual |
Reimplemented from vtkActor2D.
|
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 vtkActor2D.
|
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 vtkActor2D.
|
static |
Reimplemented from vtkActor2D.
|
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 vtkActor2D.
|
static |
Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label format, no title, and vertical orientation. The initial scalar bar size is (0.05 x 0.8) of the viewport size.
Reimplemented from vtkActor2D.
|
virtual |
Draw the scalar bar and annotation text to the screen.
Reimplemented from vtkActor2D.
|
inlinevirtual |
Draw the scalar bar and annotation text to the screen.
Reimplemented from vtkActor2D.
Definition at line 87 of file vtkScalarBarActor.h.
|
virtual |
Draw the scalar bar and annotation text to the screen.
Reimplemented from vtkActor2D.
|
virtual |
Does this prop have some translucent polygonal geometry?
Reimplemented from vtkActor2D.
|
virtual |
Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.
Reimplemented from vtkActor2D.
|
virtual |
Set/Get the vtkLookupTable to use. The lookup table specifies the number of colors to use in the table (if not overridden), as well as the scalar range.
|
virtual |
Set/Get the vtkLookupTable to use. The lookup table specifies the number of colors to use in the table (if not overridden), as well as the scalar range.
|
virtual |
Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off]
|
virtual |
Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off]
|
virtual |
Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off]
|
virtual |
Should be display the opacity as well. This is displayed by changing the opacity of the scalar bar in accordance with the opacity of the given color. For clarity, a texture grid is placed in the background if Opacity is ON. You might also want to play with SetTextureGridWith in that case. [Default: off]
|
virtual |
Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.
|
virtual |
Set/Get the maximum number of scalar bar segments to show. This may differ from the number of colors in the lookup table, in which case the colors are samples from the lookup table.
|
virtual |
Set/Get the number of annotation labels to show.
|
virtual |
Set/Get the number of annotation labels to show.
|
virtual |
Control the orientation of the scalar bar.
|
virtual |
Control the orientation of the scalar bar.
|
inline |
Control the orientation of the scalar bar.
Definition at line 136 of file vtkScalarBarActor.h.
|
inline |
Control the orientation of the scalar bar.
Definition at line 138 of file vtkScalarBarActor.h.
|
virtual |
Set/Get the title text property.
|
virtual |
Set/Get the title text property.
|
virtual |
Set/Get the labels text property.
|
virtual |
Set/Get the labels text property.
|
virtual |
Set/Get the format with which to print the labels on the scalar bar.
|
virtual |
Set/Get the format with which to print the labels on the scalar bar.
|
virtual |
Set/Get the title of the scalar bar actor,
|
virtual |
Set/Get the title of the scalar bar actor,
|
virtual |
Set/Get the title for the component that is selected,
|
virtual |
Set/Get the title for the component that is selected,
|
virtual |
Shallow copy of a scalar bar actor. Overloads the virtual vtkProp method.
Reimplemented from vtkActor2D.
|
virtual |
Set the width of the texture grid. Used only if UseOpacity is ON.
|
virtual |
Set the width of the texture grid. Used only if UseOpacity is ON.
|
virtual |
Get the texture actor.. you may want to change some properties on it
|
virtual |
Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite
|
virtual |
Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite
|
inlinevirtual |
Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite
Definition at line 197 of file vtkScalarBarActor.h.
|
inlinevirtual |
Have the text preceding the scalar bar or suceeding it ? Succeed implies the that the text is Above scalar bar if orientation is horizontal or Right of scalar bar if orientation is vertical. Precede is the opposite
Definition at line 199 of file vtkScalarBarActor.h.
|
virtual |
Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.
|
virtual |
Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.
|
virtual |
Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.
|
virtual |
Set/Get the maximum width and height in pixels. Specifying the size as a relative fraction of the viewport can sometimes undersirably strech the size of the actor too much. These methods allow the user to set bounds on the maximum size of the scalar bar in pixels along any direction. Defaults to unbounded.
|
protectedvirtual |
|
protectedvirtual |
|
protected |
Definition at line 219 of file vtkScalarBarActor.h.
|
protected |
Definition at line 220 of file vtkScalarBarActor.h.
|
protected |
Definition at line 221 of file vtkScalarBarActor.h.
|
protected |
Definition at line 223 of file vtkScalarBarActor.h.
|
protected |
Definition at line 224 of file vtkScalarBarActor.h.
|
protected |
Definition at line 225 of file vtkScalarBarActor.h.
|
protected |
Definition at line 226 of file vtkScalarBarActor.h.
|
protected |
Definition at line 227 of file vtkScalarBarActor.h.
|
protected |
Definition at line 228 of file vtkScalarBarActor.h.
|
protected |
Definition at line 229 of file vtkScalarBarActor.h.
|
protected |
Definition at line 230 of file vtkScalarBarActor.h.
|
protected |
Definition at line 231 of file vtkScalarBarActor.h.
|
protected |
Definition at line 232 of file vtkScalarBarActor.h.
|
protected |
Definition at line 234 of file vtkScalarBarActor.h.
|
protected |
Definition at line 235 of file vtkScalarBarActor.h.
|
protected |
Definition at line 239 of file vtkScalarBarActor.h.
|
protected |
Definition at line 240 of file vtkScalarBarActor.h.
|
protected |
Definition at line 243 of file vtkScalarBarActor.h.
|
protected |
Definition at line 244 of file vtkScalarBarActor.h.
|
protected |
Definition at line 245 of file vtkScalarBarActor.h.
|
protected |
Definition at line 247 of file vtkScalarBarActor.h.
|
protected |
Definition at line 248 of file vtkScalarBarActor.h.
|
protected |
Definition at line 249 of file vtkScalarBarActor.h.
|
protected |
Definition at line 251 of file vtkScalarBarActor.h.
|
protected |
Definition at line 252 of file vtkScalarBarActor.h.
|
protected |
Definition at line 253 of file vtkScalarBarActor.h.
|
protected |
Definition at line 255 of file vtkScalarBarActor.h.
|
protected |
Definition at line 256 of file vtkScalarBarActor.h.