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., wheter 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.
- Created by:
-
- CVS contributions (if > 5%):
- Schroeder, Will (87%)
- Martin, Ken (6%)
- CVS logs (CVSweb):
/Graphics/vtkButtonSource.h)/Graphics/vtkButtonSource.cxx)
Definition at line 62 of file vtkButtonSource.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkButtonSource::vtkButtonSource |
( |
|
) |
[protected] |
|
Member Function Documentation
| void vtkButtonSource::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
| virtual const char* vtkButtonSource::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkButtonSource::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
| virtual int vtkButtonSource::IsA |
( |
const char * |
type |
) |
[virtual] |
|
| 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 81 of file vtkButtonSource.h.
References VTK_TEXTURE_STYLE_FIT_IMAGE. |
| 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 83 of file vtkButtonSource.h.
References VTK_TEXTURE_STYLE_PROPORTIONAL. |
| 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] |
|
|
|
Set/Get the default texture coordinate to set the shoulder region to. |
| void vtkButtonSource::SetShoulderTextureCoordinate |
( |
double |
[2] |
) |
|
|
|
|
Set/Get the default texture coordinate to set the shoulder region to. |
| virtual double* vtkButtonSource::GetShoulderTextureCoordinate |
( |
|
) |
[virtual] |
|
|
|
Set/Get the default texture coordinate to set the shoulder region to. |
| virtual void vtkButtonSource::GetShoulderTextureCoordinate |
( |
double & |
, |
|
|
double & |
|
|
) |
[virtual] |
|
|
|
Set/Get the default texture coordinate to set the shoulder region to. |
| virtual void vtkButtonSource::GetShoulderTextureCoordinate |
( |
double |
[2] |
) |
[virtual] |
|
|
|
Set/Get the default texture coordinate to set the shoulder region to. |
| virtual void vtkButtonSource::SetTwoSided |
( |
int |
|
) |
[virtual] |
|
|
|
Indicate whether the button is single or double sided. A double sided button can be viewed from two sides...it looks sort of like a "pill." A single-sided button is meant to viewed from a single side; it looks like a "clam-shell." |
| virtual int vtkButtonSource::GetTwoSided |
( |
|
) |
[virtual] |
|
|
|
Indicate whether the button is single or double sided. A double sided button can be viewed from two sides...it looks sort of like a "pill." A single-sided button is meant to viewed from a single side; it looks like a "clam-shell." |
| virtual void vtkButtonSource::TwoSidedOn |
( |
|
) |
[virtual] |
|
|
|
Indicate whether the button is single or double sided. A double sided button can be viewed from two sides...it looks sort of like a "pill." A single-sided button is meant to viewed from a single side; it looks like a "clam-shell." |
| virtual void vtkButtonSource::TwoSidedOff |
( |
|
) |
[virtual] |
|
|
|
Indicate whether the button is single or double sided. A double sided button can be viewed from two sides...it looks sort of like a "pill." A single-sided button is meant to viewed from a single side; it looks like a "clam-shell." |
Member Data Documentation
The documentation for this class was generated from the following file: