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

represent scalar bar for vtkScalarBarWidget More...

#include <vtkScalarBarRepresentation.h>

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

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
}
 
typedef vtkWidgetRepresentation Superclass
 
- Public Types inherited from vtkWidgetRepresentation
typedef vtkProp Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkScalarBarRepresentationNewInstance () const
 
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 int GetVisibility ()
 
virtual void SetVisibility (int)
 
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)
 
vtkBorderRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void PickingManagedOn ()
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool)
 
virtual bool GetPickingManaged ()
 
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))
 
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkScalarBarRepresentationSafeDownCast (vtkObjectBase *o)
 
static vtkScalarBarRepresentationNew ()
 
- Static Public Member Functions inherited from vtkBorderRepresentation
static vtkBorderRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkBorderRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static int IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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])
 
virtual void RegisterPickers ()
 
virtual void UnRegisterPickers ()
 
virtual void PickersModified ()
 
vtkPickingManager * GetPickingManager ()
 
double SizeHandlesRelativeToViewport (double factor, double pos[3])
 
double SizeHandlesInPixels (double factor, double pos[3])
 
vtkAssemblyPath * GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 

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
 
vtkPolyDataBWPolyData
 
vtkTransformBWTransform
 
vtkTransformPolyDataFilterBWTransformFilter
 
vtkPolyDataMapper2D * BWMapper
 
vtkActor2D * BWActor
 
int MinimumSize [2]
 
int MaximumSize [2]
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRenderer > Renderer
 
int InteractionState
 
double StartEventPosition [3]
 
double PlaceFactor
 
int Placed
 
double InitialBounds [6]
 
double InitialLength
 
int ValidPick
 
bool PickingManaged
 
double HandleSize
 
int NeedToRender
 
vtkTimeStamp BuildTime
 

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
Tests:
vtkScalarBarRepresentation (Tests)

Definition at line 53 of file vtkScalarBarRepresentation.h.

Member Typedef Documentation

Definition at line 56 of file vtkScalarBarRepresentation.h.

Constructor & Destructor Documentation

vtkScalarBarRepresentation::vtkScalarBarRepresentation ( )
protected
vtkScalarBarRepresentation::~vtkScalarBarRepresentation ( )
protected

Member Function Documentation

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

Define standard methods.

Reimplemented from vtkBorderRepresentation.

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

Define standard methods.

Reimplemented from vtkBorderRepresentation.

vtkScalarBarRepresentation* vtkScalarBarRepresentation::NewInstance ( ) const
virtual void vtkScalarBarRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual
static vtkScalarBarRepresentation* vtkScalarBarRepresentation::New ( )
static
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 70 of file vtkScalarBarRepresentation.h.

virtual int vtkScalarBarRepresentation::GetVisibility ( )
virtual

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

virtual void vtkScalarBarRepresentation::SetVisibility ( int  )
virtual

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

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 97 of file vtkScalarBarRepresentation.h.


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