vtkButtonSource Class Reference

#include <vtkButtonSource.h>

Inheritance diagram for vtkButtonSource:

[legend]

Collaboration diagram for vtkButtonSource:

[legend]

List of all members.

Detailed Description

abstract class for creating various button types

vtkButtonSource is an abstract class that defines an API for creating "button-like" objects in VTK. A button is a geometry with a rectangular region that can be textured. The button is divided into two regions: the texture region and the shoulder region. The points in both regions are assigned texture coordinates. The texture region has texture coordinates consistent with the image to be placed on it. All points in the shoulder regions are assigned a texture coordinate specified by the user. In this way the shoulder region can be colored by the texture.

Creating a vtkButtonSource requires specifying its center point. (Subclasses have other attributes that must be set to control the shape of the button.) You must also specify how to control the shape of the texture region; i.e., whether to size the texture region proportional to the texture dimensions or whether to size the texture region proportional to the button. Also, buttons can be created single sided are mirrored to create two-sided buttons.

See also:: vtkEllipticalButtonSource vtkRectangularButtonSource

Warning:: The button is defined in the x-y plane. Use vtkTransformPolyDataFilter or vtkGlyph3D to orient the button in a different direction.

Definition at line 51 of file vtkButtonSource.h.


Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)

virtual void	SetCenter (double, double, double)
virtual void	SetCenter (double[3])
virtual double *	GetCenter ()
virtual void	GetCenter (double data[3])

virtual void	SetTextureStyle (int)
virtual int	GetTextureStyle ()
void	SetTextureStyleToFitImage ()
void	SetTextureStyleToProportional ()

virtual void	SetTextureDimensions (int, int)
void	SetTextureDimensions (int[2])
virtual int *	GetTextureDimensions ()
virtual void	GetTextureDimensions (int &, int &)
virtual void	GetTextureDimensions (int[2])

virtual void	SetShoulderTextureCoordinate (double, double)
void	SetShoulderTextureCoordinate (double[2])
virtual double *	GetShoulderTextureCoordinate ()
virtual void	GetShoulderTextureCoordinate (double &, double &)
virtual void	GetShoulderTextureCoordinate (double[2])

virtual void	SetTwoSided (int)
virtual int	GetTwoSided ()
virtual void	TwoSidedOn ()
virtual void	TwoSidedOff ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkButtonSource *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkButtonSource ()
	~vtkButtonSource ()
Protected Attributes
double	Center [3]
double	ShoulderTextureCoordinate [2]
int	TextureStyle
int	TextureDimensions [2]
int	TwoSided

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkButtonSource::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkEllipticalButtonSource, and vtkRectangularButtonSource.

Definition at line 55 of file vtkButtonSource.h.

Constructor & Destructor Documentation

vtkButtonSource::vtkButtonSource ( ) [protected]

vtkButtonSource::~vtkButtonSource ( ) [inline, protected]

Definition at line 101 of file vtkButtonSource.h.

Member Function Documentation

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

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkEllipticalButtonSource, and vtkRectangularButtonSource.

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

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkEllipticalButtonSource, and vtkRectangularButtonSource.

static int vtkButtonSource::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkEllipticalButtonSource, and vtkRectangularButtonSource.

virtual int vtkButtonSource::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkEllipticalButtonSource, and vtkRectangularButtonSource.

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

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkEllipticalButtonSource, and vtkRectangularButtonSource.

virtual void vtkButtonSource::SetCenter	(	double	,
		double	,
		double
	)			`[virtual]`

Specify a point defining the origin (center) of the button.

virtual void vtkButtonSource::SetCenter ( double [3] ) [virtual]

Specify a point defining the origin (center) of the button.

virtual double* vtkButtonSource::GetCenter ( ) [virtual]

Specify a point defining the origin (center) of the button.

virtual void vtkButtonSource::GetCenter ( double data[3] ) [virtual]

Specify a point defining the origin (center) of the button.

virtual void vtkButtonSource::SetTextureStyle ( int ) [virtual]

Set/Get the style of the texture region: whether to size it according to the x-y dimensions of the texture, or whether to make the texture region proportional to the width/height of the button.

virtual int vtkButtonSource::GetTextureStyle ( ) [virtual]

Set/Get the style of the texture region: whether to size it according to the x-y dimensions of the texture, or whether to make the texture region proportional to the width/height of the button.

void vtkButtonSource::SetTextureStyleToFitImage ( ) [inline]

Set/Get the style of the texture region: whether to size it according to the x-y dimensions of the texture, or whether to make the texture region proportional to the width/height of the button.

Definition at line 70 of file vtkButtonSource.h.

void vtkButtonSource::SetTextureStyleToProportional ( ) [inline]

Set/Get the style of the texture region: whether to size it according to the x-y dimensions of the texture, or whether to make the texture region proportional to the width/height of the button.

Definition at line 72 of file vtkButtonSource.h.

virtual void vtkButtonSource::SetTextureDimensions	(	int	,
		int
	)			`[virtual]`

Set/get the texture dimension. This needs to be set if the texture style is set to fit the image.

void vtkButtonSource::SetTextureDimensions ( int [2] )

Set/get the texture dimension. This needs to be set if the texture style is set to fit the image.

virtual int* vtkButtonSource::GetTextureDimensions ( ) [virtual]

Set/get the texture dimension. This needs to be set if the texture style is set to fit the image.

virtual void vtkButtonSource::GetTextureDimensions	(	int &	,
		int &
	)			`[virtual]`

Set/get the texture dimension. This needs to be set if the texture style is set to fit the image.

virtual void vtkButtonSource::GetTextureDimensions ( int [2] ) [virtual]

Set/get the texture dimension. This needs to be set if the texture style is set to fit the image.

virtual void vtkButtonSource::SetShoulderTextureCoordinate	(	double	,
		double
	)			`[virtual]`