vtkProp3DButtonRepresentation Class Reference

#include <vtkProp3DButtonRepresentation.h>

Inheritance diagram for vtkProp3DButtonRepresentation:

[legend]

Collaboration diagram for vtkProp3DButtonRepresentation:

[legend]

List of all members.

Detailed Description

defines a representation for a vtkButtonWidget

This class implements one type of vtkButtonRepresentation. Each button state can be represented with a separate instance of vtkProp3D. Thus buttons can be represented with vtkActor, vtkImageActor, volumes (e.g., vtkVolume) and/or any other vtkProp3D. Also, the class invokes events when highlighting occurs (i.e., hovering, selecting) so that appropriate action can be taken to highlight the button (if desired).

To use this representation, always begin by specifying the number of button states. Then provide, for each state, an instance of vtkProp3D.

This widget representation uses the conventional placement method. The button is placed inside the bounding box defined by PlaceWidget by translating and scaling the vtkProp3D to fit (each vtkProp3D is transformed). Therefore, you must define the number of button states and each state (i.e., vtkProp3D) prior to calling vtkPlaceWidget.

See also:: vtkButtonWidget vtkButtonRepresentation vtkButtonSource vtkEllipticalButtonSource vtkRectangularButtonSource

Tests:: vtkProp3DButtonRepresentation (Tests)

Definition at line 52 of file vtkProp3DButtonRepresentation.h.


typedef vtkButtonRepresentation	Superclass
static int	IsTypeOf (const char *type)
static vtkProp3DButtonRepresentation *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Public Member Functions
virtual void	SetState (int state)
virtual void	PlaceWidget (double bounds[6])

void	SetButtonProp (int i, vtkProp3D *prop)
vtkProp3D *	GetButtonProp (int i)

virtual void	SetFollowCamera (int)
virtual int	GetFollowCamera ()
virtual void	FollowCameraOn ()
virtual void	FollowCameraOff ()

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

virtual void	ShallowCopy (vtkProp *prop)
virtual double *	GetBounds ()
virtual void	GetActors (vtkPropCollection *pc)
virtual void	ReleaseGraphicsResources (vtkWindow *)
virtual int	RenderOpaqueGeometry (vtkViewport *)
virtual int	RenderVolumetricGeometry (vtkViewport *)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	HasTranslucentPolygonalGeometry ()
Static Public Member Functions
static vtkProp3DButtonRepresentation *	New ()
Protected Member Functions
	vtkProp3DButtonRepresentation ()
	~vtkProp3DButtonRepresentation ()
Protected Attributes
vtkProp3D *	CurrentProp
vtkProp3DFollower *	Follower
int	FollowCamera
vtkPropArray *	PropArray
vtkPropPicker *	Picker

Member Typedef Documentation

typedef vtkButtonRepresentation vtkProp3DButtonRepresentation::Superclass

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

Definition at line 60 of file vtkProp3DButtonRepresentation.h.

Constructor & Destructor Documentation

vtkProp3DButtonRepresentation::vtkProp3DButtonRepresentation ( ) [protected]

vtkProp3DButtonRepresentation::~vtkProp3DButtonRepresentation ( ) [protected]

Member Function Documentation

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

Instantiate the class.

Reimplemented from vtkObject.

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

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

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

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

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

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

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

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

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

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

void vtkProp3DButtonRepresentation::SetButtonProp	(	int	i,
		vtkProp3D *	prop
	)

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

vtkProp3D* vtkProp3DButtonRepresentation::GetButtonProp ( int i )

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

virtual void vtkProp3DButtonRepresentation::SetFollowCamera ( int ) [virtual]

Specify whether the button should always face the camera. If enabled, the button reorients itself towards the camera as the camera moves.

virtual int vtkProp3DButtonRepresentation::GetFollowCamera ( ) [virtual]

Specify whether the button should always face the camera. If enabled, the button reorients itself towards the camera as the camera moves.

virtual void vtkProp3DButtonRepresentation::FollowCameraOn ( ) [virtual]

Specify whether the button should always face the camera. If enabled, the button reorients itself towards the camera as the camera moves.

virtual void vtkProp3DButtonRepresentation::FollowCameraOff ( ) [virtual]

Specify whether the button should always face the camera. If enabled, the button reorients itself towards the camera as the camera moves.

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

Extend the vtkButtonRepresentation::SetState() method.

Reimplemented from vtkButtonRepresentation.

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

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkProp3DButtonRepresentation::BuildRepresentation ( ) [virtual]

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Implements vtkWidgetRepresentation.

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

This method positions (translates and scales the props) into the bounding box specified. Note all the button props are scaled.

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