defines a representation for a vtkButtonWidget More...

#include <vtkTexturedButtonRepresentation2D.h>

Inheritance diagram for vtkTexturedButtonRepresentation2D:

Collaboration diagram for vtkTexturedButtonRepresentation2D:

Public Member Functions
vtkBalloonRepresentation *	GetBalloon ()
virtual void	PlaceWidget (double bounds[6])
virtual void	PlaceWidget (double anchor[3], int size[2])

virtual void	SetProperty (vtkProperty2D *p)
virtual vtkProperty2D *	GetProperty ()

virtual void	SetHoveringProperty (vtkProperty2D *p)
virtual vtkProperty2D *	GetHoveringProperty ()

virtual void	SetSelectingProperty (vtkProperty2D *p)
virtual vtkProperty2D *	GetSelectingProperty ()

void	SetButtonTexture (int i, vtkImageData *image)
vtkImageData *	GetButtonTexture (int i)

virtual int	ComputeInteractionState (int X, int Y, int modify=0)
virtual void	BuildRepresentation ()
virtual void	Highlight (int state)

virtual void	ShallowCopy (vtkProp *prop)
virtual double *	GetBounds ()
virtual void	GetActors (vtkPropCollection *pc)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual int	RenderOverlay (vtkViewport *)
virtual int	HasTranslucentPolygonalGeometry ()
Static Public Member Functions
static vtkTexturedButtonRepresentation2D *	New ()
Protected Member Functions
	vtkTexturedButtonRepresentation2D ()
	~vtkTexturedButtonRepresentation2D ()
void	CreateDefaultProperties ()
Protected Attributes
vtkBalloonRepresentation *	Balloon
vtkProperty2D *	Property
vtkProperty2D *	HoveringProperty
vtkProperty2D *	SelectingProperty
vtkTextureArray *	TextureArray
vtkCoordinate *	Anchor
typedef vtkButtonRepresentation	Superclass
static int	IsTypeOf (const char *type)
static vtkTexturedButtonRepresentation2D *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkTexturedButtonRepresentation2D *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

defines a representation for a vtkButtonWidget

This class implements one type of vtkButtonRepresentation. It changes the appearance of a user-provided polydata by assigning textures according to the current button state. It also provides highlighting (when hovering and selecting the button) by fiddling with the actor's property. Since this is a 2D version, the button is rendered in the overlay plane. Typically it is positioned in display coordinates, but it can be anchored to a world position so it will appear to move as the camera moves.

To use this representation, always begin by specifying the number of button states. Then provide a polydata (the polydata should have associated texture coordinates), and a list of textures cooresponding to the button states. Optionally, the HoveringProperty and SelectionProperty can be adjusted to obtain the appropriate appearance.

,SECTION Caveats There are two variants of the PlaceWidget() method. The first PlaceWidget(bds[6]) allows the widget to be placed in the display coordinates fixed to the overlay plane. The second PlaceWidget(anchor[3],size[2]) places the widget in world space; hence it will appear to move as the camera moves around the scene.

See also:: vtkButtonWidget vtkButtonRepresentation vtkTexturedButtonRepresentation vtkProp3DButtonRepresentation

Tests:: vtkTexturedButtonRepresentation2D (Tests)

Definition at line 61 of file vtkTexturedButtonRepresentation2D.h.

Member Typedef Documentation

typedef vtkButtonRepresentation vtkTexturedButtonRepresentation2D::Superclass

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

Definition at line 69 of file vtkTexturedButtonRepresentation2D.h.

Constructor & Destructor Documentation

vtkTexturedButtonRepresentation2D::vtkTexturedButtonRepresentation2D ( ) [protected]

vtkTexturedButtonRepresentation2D::~vtkTexturedButtonRepresentation2D ( ) [protected]

Member Function Documentation

static vtkTexturedButtonRepresentation2D* vtkTexturedButtonRepresentation2D::New ( ) [static]

Instantiate the class.

Reimplemented from vtkObject.

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

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

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

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

static vtkTexturedButtonRepresentation2D* vtkTexturedButtonRepresentation2D::SafeDownCast ( vtkObjectBase * o ) [static]

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

virtual vtkObjectBase* vtkTexturedButtonRepresentation2D::NewInstanceInternal ( ) const [protected, virtual]

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

vtkTexturedButtonRepresentation2D* vtkTexturedButtonRepresentation2D::NewInstance ( ) const

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

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

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

virtual void vtkTexturedButtonRepresentation2D::SetProperty ( vtkProperty2D * p ) [virtual]

Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button.

virtual vtkProperty2D* vtkTexturedButtonRepresentation2D::GetProperty ( ) [virtual]

Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button.

virtual void vtkTexturedButtonRepresentation2D::SetHoveringProperty ( vtkProperty2D * p ) [virtual]

Specify the property to use when the hovering over the button.

virtual vtkProperty2D* vtkTexturedButtonRepresentation2D::GetHoveringProperty ( ) [virtual]

Specify the property to use when the hovering over the button.

virtual void vtkTexturedButtonRepresentation2D::SetSelectingProperty ( vtkProperty2D * p ) [virtual]

Specify the property to use when selecting the button.

virtual vtkProperty2D* vtkTexturedButtonRepresentation2D::GetSelectingProperty ( ) [virtual]

Specify the property to use when selecting the button.

void vtkTexturedButtonRepresentation2D::SetButtonTexture	(	int	i,
		vtkImageData *	image
	)

Add the ith texture corresponding to the ith button state. The parameter i should be 0<=i<NumberOfStates.

vtkImageData* vtkTexturedButtonRepresentation2D::GetButtonTexture ( int i )

Add the ith texture corresponding to the ith button state. The parameter i should be 0<=i<NumberOfStates.

vtkBalloonRepresentation* vtkTexturedButtonRepresentation2D::GetBalloon ( ) [inline]

Grab the underlying vtkBalloonRepresentation used to position and display the button texture.

Definition at line 101 of file vtkTexturedButtonRepresentation2D.h.

virtual int vtkTexturedButtonRepresentation2D::ComputeInteractionState	(	int	X,
		int	Y,
		int	modify = `0`
	)		`[virtual]`

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkTexturedButtonRepresentation2D::BuildRepresentation ( ) [virtual]

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Implements vtkWidgetRepresentation.

virtual void vtkTexturedButtonRepresentation2D::Highlight ( int state ) [virtual]

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from vtkButtonRepresentation.

virtual void vtkTexturedButtonRepresentation2D::PlaceWidget ( double bounds[6] ) [virtual]

Conventional PlaceWidget() method to satisfy the vtkWidgetRepresentation API. In this version, bounds[6] specifies a rectangle in display coordinates in which to place the button. The values for bounds[4] and bounds[5] can be set to zero. Note that PlaceWidget() is typically called at the end of configuring the button representation.

virtual void vtkTexturedButtonRepresentation2D::PlaceWidget	(	double	anchor[3],
		int	size[2]
	)		`[virtual]`

This alternative PlaceWidget() method can be used to anchor the button to a 3D point. In this case, the button representation will move around the screen as the camera moves around the world space. The first parameter anchor[3] is the world point anchor position (attached to the lower left portion of the button by default); and the size[2] parameter defines a x-y box in display coordinates in which the button will fit. Note that you can grab the vtkBalloonRepresentation and set an offset value if the anchor point is to be elsewhere on the button.

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

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkButtonRepresentation.

virtual double* vtkTexturedButtonRepresentation2D::GetBounds ( ) [virtual]

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkTexturedButtonRepresentation2D::GetActors ( vtkPropCollection * pc ) [virtual]

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkTexturedButtonRepresentation2D::ReleaseGraphicsResources ( vtkWindow * ) [virtual]

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.