vtkScalarBarRepresentation Class Reference

#include <vtkScalarBarRepresentation.h>

Inheritance diagram for vtkScalarBarRepresentation:

[legend]

Collaboration diagram for vtkScalarBarRepresentation:

[legend]

List of all members.

---

Detailed Description

represent scalar bar for vtkScalarBarWidget

This class represents a scalar bar for a vtkScalarBarWidget. This class provides support for interactively placing a scalar bar on the 2D overlay plane. The scalar bar is defined by an instance of vtkScalarBarActor.

One specialty of this class is that if the scalar bar is moved near enough to an edge, it's orientation is flipped to match that edge.

See also:

vtkScalarBarWidget vtkWidgetRepresentation vtkScalarBarActor

Definition at line 49 of file vtkScalarBarRepresentation.h.

Public Types
typedef vtkBorderRepresentation	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkScalarBarActor *	GetScalarBarActor ()
virtual void	SetScalarBarActor (vtkScalarBarActor *)
virtual void	BuildRepresentation ()
virtual void	WidgetInteraction (double eventPos[2])
virtual void	GetSize (double size[2])
virtual void	GetActors2D (vtkPropCollection *collection)
virtual void	ReleaseGraphicsResources (vtkWindow *window)
virtual int	RenderOverlay (vtkViewport *)
virtual int	RenderOpaqueGeometry (vtkViewport *)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	HasTranslucentPolygonalGeometry ()
void	SetOrientation (int orient)
int	GetOrientation ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkScalarBarRepresentation *	SafeDownCast (vtkObject *o)
static vtkScalarBarRepresentation *	New ()
Protected Member Functions
	vtkScalarBarRepresentation ()
	~vtkScalarBarRepresentation ()
Protected Attributes
vtkScalarBarActor *	ScalarBarActor

---

Member Typedef Documentation

typedef vtkBorderRepresentation vtkScalarBarRepresentation::Superclass

Define standard methods.

Reimplemented from vtkBorderRepresentation.

Definition at line 52 of file vtkScalarBarRepresentation.h.

---

Constructor & Destructor Documentation

vtkScalarBarRepresentation::vtkScalarBarRepresentation

(

)

[protected]

vtkScalarBarRepresentation::~vtkScalarBarRepresentation

(

)

[protected]

---

Member Function Documentation

virtual const char* vtkScalarBarRepresentation::GetClassName

(

)

[virtual]

Define standard methods.

Reimplemented from vtkBorderRepresentation.

static int vtkScalarBarRepresentation::IsTypeOf

(

const char *

type

)

[static]

Define standard methods.

Reimplemented from vtkBorderRepresentation.

virtual int vtkScalarBarRepresentation::IsA

(

const char *

type

)

[virtual]

Define standard methods.

Reimplemented from vtkBorderRepresentation.

static vtkScalarBarRepresentation* vtkScalarBarRepresentation::SafeDownCast

(

vtkObject *

o

)

[static]

Define standard methods.

Reimplemented from vtkBorderRepresentation.

virtual void vtkScalarBarRepresentation::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Define standard methods.

Reimplemented from vtkBorderRepresentation.

static vtkScalarBarRepresentation* vtkScalarBarRepresentation::New

(

)

[static]

Instantiate this class.

Reimplemented from vtkBorderRepresentation.

virtual vtkScalarBarActor* vtkScalarBarRepresentation::GetScalarBarActor

(

)

[virtual]

The prop that is placed in the renderer.

virtual void vtkScalarBarRepresentation::SetScalarBarActor

(

vtkScalarBarActor *

)

[virtual]

The prop that is placed in the renderer.

virtual void vtkScalarBarRepresentation::BuildRepresentation

(

)

[virtual]

Satisfy the superclass' API.

Reimplemented from vtkBorderRepresentation.

virtual void vtkScalarBarRepresentation::WidgetInteraction

(

double

eventPos[2]

)

[virtual]

Satisfy the superclass' API.

Reimplemented from vtkBorderRepresentation.

virtual void vtkScalarBarRepresentation::GetSize

(

double

size[2]

)

[inline, virtual]

Satisfy the superclass' API.

Reimplemented from vtkBorderRepresentation.

Definition at line 66 of file vtkScalarBarRepresentation.h.

virtual void vtkScalarBarRepresentation::GetActors2D

(

vtkPropCollection *

collection

)

[virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual void vtkScalarBarRepresentation::ReleaseGraphicsResources

(

vtkWindow *

window

)

[virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkScalarBarRepresentation::RenderOverlay

(

vtkViewport *

)

[virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkScalarBarRepresentation::RenderOpaqueGeometry

(

vtkViewport *

)

[virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkScalarBarRepresentation::RenderTranslucentPolygonalGeometry

(

vtkViewport *

)

[virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkScalarBarRepresentation::HasTranslucentPolygonalGeometry

(

)

[virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

void vtkScalarBarRepresentation::SetOrientation

(

int

orient

)

Get/Set the orientation.

int vtkScalarBarRepresentation::GetOrientation

(

)

Get/Set the orientation.

---

Member Data Documentation

vtkScalarBarActor* vtkScalarBarRepresentation::ScalarBarActor [protected]

Definition at line 91 of file vtkScalarBarRepresentation.h.

---

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

• dox/Widgets/vtkScalarBarRepresentation.h