represent scalar bar for vtkScalarBarWidget More...

#include <vtkScalarBarRepresentation.h>

Inheritance diagram for vtkScalarBarRepresentation:

Collaboration diagram for vtkScalarBarRepresentation:

Public Types
typedef vtkBorderRepresentation	Superclass
Public Types inherited from vtkBorderRepresentation
enum	{ BORDER_OFF = 0, BORDER_ON, BORDER_ACTIVE }
enum	_InteractionState { Outside = 0, Inside, AdjustingP0, AdjustingP1, AdjustingP2, AdjustingP3, AdjustingE0, AdjustingE1, AdjustingE2, AdjustingE3 }
Public Types inherited from vtkProp
Public Types inherited from vtkObject

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 ()
Public Member Functions inherited from vtkBorderRepresentation
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 ()
virtual void	SetShowBorder (int)
virtual int	GetShowBorder ()
void	SetShowBorderToOff ()
void	SetShowBorderToOn ()
void	SetShowBorderToActive ()
virtual vtkProperty2D *	GetBorderProperty ()
virtual void	SetProportionalResize (int)
virtual int	GetProportionalResize ()
virtual void	ProportionalResizeOn ()
virtual void	ProportionalResizeOff ()
virtual void	SetMinimumSize (int, int)
void	SetMinimumSize (int[2])
virtual int *	GetMinimumSize ()
virtual void	GetMinimumSize (int &, int &)
virtual void	GetMinimumSize (int[2])
virtual void	SetMaximumSize (int, int)
void	SetMaximumSize (int[2])
virtual int *	GetMaximumSize ()
virtual void	GetMaximumSize (int &, int &)
virtual void	GetMaximumSize (int[2])
virtual void	SetTolerance (int)
virtual int	GetTolerance ()
virtual double *	GetSelectionPoint ()
virtual void	GetSelectionPoint (double data[2])
virtual void	SetMoving (int)
virtual int	GetMoving ()
virtual void	MovingOn ()
virtual void	MovingOff ()
virtual void	StartWidgetInteraction (double eventPos[2])
virtual int	ComputeInteractionState (int X, int Y, int modify=0)
Public Member Functions inherited from vtkWidgetRepresentation
virtual void	SetRenderer (vtkRenderer *ren)
virtual vtkRenderer *	GetRenderer ()
virtual void	PlaceWidget (double *vtkNotUsed(bounds[6]))
virtual void	EndWidgetInteraction (double newEventPos[2])
virtual int	GetInteractionState ()
virtual void	Highlight (int vtkNotUsed(highlightOn))
virtual void	SetPlaceFactor (double)
virtual double	GetPlaceFactor ()
virtual void	SetHandleSize (double)
virtual double	GetHandleSize ()
virtual int	GetNeedToRender ()
virtual void	SetNeedToRender (int)
virtual void	NeedToRenderOn ()
virtual void	NeedToRenderOff ()
virtual double *	GetBounds ()
virtual void	ShallowCopy (vtkProp *prop)
virtual void	GetActors (vtkPropCollection *)
virtual void	GetVolumes (vtkPropCollection *)
virtual int	RenderOverlay (vtkViewport *vtkNotUsed(viewport))
virtual int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))
Public Member Functions inherited from vtkProp
virtual void	Pick ()
virtual unsigned long	GetRedrawMTime ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
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)
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
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)
Public Member Functions inherited from vtkObjectBase
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 vtkScalarBarRepresentation *	SafeDownCast (vtkObject *o)
static vtkScalarBarRepresentation *	New ()

Protected Member Functions
	vtkScalarBarRepresentation ()
	~vtkScalarBarRepresentation ()
Protected Member Functions inherited from vtkBorderRepresentation
	vtkBorderRepresentation ()
	~vtkBorderRepresentation ()
virtual void	NegotiateLayout ()
Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()
	~vtkWidgetRepresentation ()
void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])
double	SizeHandlesRelativeToViewport (double factor, double pos[3])
double	SizeHandlesInPixels (double factor, double pos[3])
Protected Member Functions inherited from vtkProp
	vtkProp ()
	~vtkProp ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &os)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkScalarBarActor *	ScalarBarActor
Protected Attributes inherited from vtkBorderRepresentation
int	ShowBorder
vtkProperty2D *	BorderProperty
int	ProportionalResize
int	Tolerance
int	Moving
double	SelectionPoint [2]
vtkCoordinate *	PositionCoordinate
vtkCoordinate *	Position2Coordinate
int	Negotiated
double	StartPosition [2]
vtkPoints *	BWPoints
vtkPolyData *	BWPolyData
vtkTransform *	BWTransform
vtkTransformPolyDataFilter *	BWTransformFilter
vtkPolyDataMapper2D *	BWMapper
vtkActor2D *	BWActor
int	MinimumSize [2]
int	MaximumSize [2]
Protected Attributes inherited from vtkWidgetRepresentation
vtkRenderer *	Renderer
int	InteractionState
double	StartEventPosition [3]
double	PlaceFactor
int	Placed
double	InitialBounds [6]
double	InitialLength
int	ValidPick
double	HandleSize
int	NeedToRender
vtkTimeStamp	BuildTime
Protected Attributes inherited from vtkProp
int	Visibility
int	Pickable
int	Dragable
bool	UseBounds
double	AllocatedRenderTime
double	EstimatedRenderTime
double	SavedEstimatedRenderTime
double	RenderTimeMultiplier
int	NumberOfConsumers
vtkObject **	Consumers
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	ReferenceCount
vtkWeakPointerBase **	WeakPointers

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.

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] )

inlinevirtual

Satisfy the superclass' API.

Reimplemented from vtkBorderRepresentation.

Definition at line 66 of file vtkScalarBarRepresentation.h.

virtual void vtkScalarBarRepresentation::GetActors2D ( vtkPropCollection * collection )

virtual