vtkButtonRepresentation Class Reference

#include <vtkButtonRepresentation.h>

Inheritance diagram for vtkButtonRepresentation:

[legend]

Collaboration diagram for vtkButtonRepresentation:

[legend]

List of all members.

Detailed Description

abstract class defines the representation for a vtkButtonWidget

This abstract class is used to specify how the vtkButtonWidget should interact with representations of the vtkButtonWidget. This class may be subclassed so that alternative representations can be created. The class defines an API, and a default implementation, that the vtkButtonWidget interacts with to render itself in the scene.

The vtkButtonWidget assumes an n-state button so that traveral methods are available for changing, querying and manipulating state. Derived classed determine the actual appearance. The state is represented by an integral value 0<=state<numStates.

To use this representation, always begin by specifying the number of states. Then follow with the necessary information to represent each state (done through a subclass API).

See also:: vtkButtonWidget

Events:: vtkCommand::HighlightEvent

Definition at line 46 of file vtkButtonRepresentation.h.


enum	_HighlightState { HighlightNormal, HighlightHovering, HighlightSelecting }
virtual void	Highlight (int)
virtual int	GetHighlightState ()
typedef vtkWidgetRepresentation	Superclass
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
static int	IsTypeOf (const char *type)
static vtkButtonRepresentation *	SafeDownCast (vtkObject *o)
Public Types
enum	_InteractionState { Outside = 0, Inside }
Public Member Functions
virtual void	ShallowCopy (vtkProp *prop)

virtual void	SetNumberOfStates (int)

virtual int	GetState ()

virtual void	SetState (int state)
virtual void	NextState ()
virtual void	PreviousState ()
Protected Member Functions
	vtkButtonRepresentation ()
	~vtkButtonRepresentation ()
Protected Attributes
int	NumberOfStates
int	State
int	HighlightState

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkButtonRepresentation::Superclass

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

Definition at line 51 of file vtkButtonRepresentation.h.

Member Enumeration Documentation

enum vtkButtonRepresentation::_InteractionState

Enumerator:

Outside
Inside

Definition at line 75 of file vtkButtonRepresentation.h.

enum vtkButtonRepresentation::_HighlightState

These methods control the appearance of the button as it is being interacted with. Subclasses will behave differently depending on their particulars. HighlightHovering is used when the mouse pointer moves over the button. HighlightSelecting is set when the button is selected. Otherwise, the HighlightNormal is used. The Highlight() method will throw a vtkCommand::HighlightEvent.

Enumerator:

HighlightNormal
HighlightHovering
HighlightSelecting

Definition at line 89 of file vtkButtonRepresentation.h.

Constructor & Destructor Documentation

vtkButtonRepresentation::vtkButtonRepresentation ( ) [protected]

vtkButtonRepresentation::~vtkButtonRepresentation ( ) [protected]

Member Function Documentation

virtual const char* vtkButtonRepresentation::GetClassName ( ) [virtual]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

static int vtkButtonRepresentation::IsTypeOf ( const char * type ) [static]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

virtual int vtkButtonRepresentation::IsA ( const char * type ) [virtual]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

static vtkButtonRepresentation* vtkButtonRepresentation::SafeDownCast ( vtkObject * o ) [static]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

virtual void vtkButtonRepresentation::SetNumberOfStates ( int ) [virtual]

Retrieve the current button state.

virtual int vtkButtonRepresentation::GetState ( ) [virtual]

Retrieve the current button state.

virtual void vtkButtonRepresentation::SetState ( int state ) [virtual]

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

Reimplemented in vtkProp3DButtonRepresentation.

virtual void vtkButtonRepresentation::NextState ( ) [virtual]

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

virtual void vtkButtonRepresentation::PreviousState ( ) [virtual]

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

virtual void vtkButtonRepresentation::Highlight ( int ) [virtual]

These methods control the appearance of the button as it is being interacted with. Subclasses will behave differently depending on their particulars. HighlightHovering is used when the mouse pointer moves over the button. HighlightSelecting is set when the button is selected. Otherwise, the HighlightNormal is used. The Highlight() method will throw a vtkCommand::HighlightEvent.

Reimplemented in vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

virtual int vtkButtonRepresentation::GetHighlightState ( ) [virtual]

These methods control the appearance of the button as it is being interacted with. Subclasses will behave differently depending on their particulars. HighlightHovering is used when the mouse pointer moves over the button. HighlightSelecting is set when the button is selected. Otherwise, the HighlightNormal is used. The Highlight() method will throw a vtkCommand::HighlightEvent.

virtual void vtkButtonRepresentation::ShallowCopy ( vtkProp * prop ) [virtual]

Satisfy some of vtkProp's API.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.