VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkEllipticalButtonSource Class Reference

create a ellipsoidal-shaped button More...

#include <vtkEllipticalButtonSource.h>

Inheritance diagram for vtkEllipticalButtonSource:
[legend]
Collaboration diagram for vtkEllipticalButtonSource:
[legend]

Public Types

typedef vtkButtonSource Superclass
 
- Public Types inherited from vtkButtonSource
typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int IsA (const char *type)
 
vtkEllipticalButtonSourceNewInstance () const
 
virtual void SetWidth (double)
 
virtual double GetWidth ()
 
virtual void SetHeight (double)
 
virtual double GetHeight ()
 
virtual void SetDepth (double)
 
virtual double GetDepth ()
 
virtual void SetCircumferentialResolution (int)
 
virtual int GetCircumferentialResolution ()
 
virtual void SetTextureResolution (int)
 
virtual int GetTextureResolution ()
 
virtual void SetShoulderResolution (int)
 
virtual int GetShoulderResolution ()
 
virtual void SetRadialRatio (double)
 
virtual double GetRadialRatio ()
 
- Public Member Functions inherited from vtkButtonSource
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkButtonSourceNewInstance () const
 
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 ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkEllipticalButtonSourceSafeDownCast (vtkObjectBase *o)
 
static vtkEllipticalButtonSourceNew ()
 
- Static Public Member Functions inherited from vtkButtonSource
static int IsTypeOf (const char *type)
 
static vtkButtonSourceSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkEllipticalButtonSource ()
 
 ~vtkEllipticalButtonSource ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkButtonSource
 vtkButtonSource ()
 
 ~vtkButtonSource ()
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutiveCreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Protected Attributes

double Width
 
double Height
 
double Depth
 
int CircumferentialResolution
 
int TextureResolution
 
int ShoulderResolution
 
double RadialRatio
 
- Protected Attributes inherited from vtkButtonSource
double Center [3]
 
double ShoulderTextureCoordinate [2]
 
int TextureStyle
 
int TextureDimensions [2]
 
int TwoSided
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

create a ellipsoidal-shaped button

vtkEllipticalButtonSource creates a ellipsoidal shaped button with texture coordinates suitable for application of a texture map. This provides a way to make nice looking 3D buttons. The buttons are represented as vtkPolyData that includes texture coordinates and normals. The button lies in the x-y plane.

To use this class you must define the major and minor axes lengths of an ellipsoid (expressed as width (x), height (y) and depth (z)). The button has a rectangular mesh region in the center with texture coordinates that range smoothly from (0,1). (This flat region is called the texture region.) The outer, curved portion of the button (called the shoulder) has texture coordinates set to a user specified value (by default (0,0). (This results in coloring the button curve the same color as the (s,t) location of the texture map.) The resolution in the radial direction, the texture region, and the shoulder region must also be set. The button can be moved by specifying an origin.

See Also
vtkButtonSource vtkRectangularButtonSource
Tests:
vtkEllipticalButtonSource (Tests)

Definition at line 52 of file vtkEllipticalButtonSource.h.

Member Typedef Documentation

Definition at line 56 of file vtkEllipticalButtonSource.h.

Constructor & Destructor Documentation

vtkEllipticalButtonSource::vtkEllipticalButtonSource ( )
protected
vtkEllipticalButtonSource::~vtkEllipticalButtonSource ( )
inlineprotected

Definition at line 114 of file vtkEllipticalButtonSource.h.

Member Function Documentation

void vtkEllipticalButtonSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
static int vtkEllipticalButtonSource::IsTypeOf ( const char *  type)
static
virtual int vtkEllipticalButtonSource::IsA ( const char *  type)
virtual

Reimplemented from vtkButtonSource.

static vtkEllipticalButtonSource* vtkEllipticalButtonSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkEllipticalButtonSource::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkButtonSource.

vtkEllipticalButtonSource* vtkEllipticalButtonSource::NewInstance ( ) const
static vtkEllipticalButtonSource* vtkEllipticalButtonSource::New ( )
static

Construct a circular button with depth 10% of its height.

virtual void vtkEllipticalButtonSource::SetWidth ( double  )
virtual

Set/Get the width of the button (the x-ellipsoid axis length * 2).

virtual double vtkEllipticalButtonSource::GetWidth ( )
virtual

Set/Get the width of the button (the x-ellipsoid axis length * 2).

virtual void vtkEllipticalButtonSource::SetHeight ( double  )
virtual

Set/Get the height of the button (the y-ellipsoid axis length * 2).

virtual double vtkEllipticalButtonSource::GetHeight ( )
virtual

Set/Get the height of the button (the y-ellipsoid axis length * 2).

virtual void vtkEllipticalButtonSource::SetDepth ( double  )
virtual

Set/Get the depth of the button (the z-eliipsoid axis length).

virtual double vtkEllipticalButtonSource::GetDepth ( )
virtual

Set/Get the depth of the button (the z-eliipsoid axis length).

virtual void vtkEllipticalButtonSource::SetCircumferentialResolution ( int  )
virtual

Specify the resolution of the button in the circumferential direction.

virtual int vtkEllipticalButtonSource::GetCircumferentialResolution ( )
virtual

Specify the resolution of the button in the circumferential direction.

virtual void vtkEllipticalButtonSource::SetTextureResolution ( int  )
virtual

Specify the resolution of the texture in the radial direction in the texture region.

virtual int vtkEllipticalButtonSource::GetTextureResolution ( )
virtual

Specify the resolution of the texture in the radial direction in the texture region.

virtual void vtkEllipticalButtonSource::SetShoulderResolution ( int  )
virtual

Specify the resolution of the texture in the radial direction in the shoulder region.

virtual int vtkEllipticalButtonSource::GetShoulderResolution ( )
virtual

Specify the resolution of the texture in the radial direction in the shoulder region.

virtual void vtkEllipticalButtonSource::SetRadialRatio ( double  )
virtual

Set/Get the radial ratio. This is the measure of the radius of the outer ellipsoid to the inner ellipsoid of the button. The outer ellipsoid is the boundary of the button defined by the height and width. The inner ellipsoid circumscribes the texture region. Larger RadialRatio's cause the button to be more rounded (and the texture region to be smaller); smaller ratios produce sharply curved shoulders with a larger texture region.

virtual double vtkEllipticalButtonSource::GetRadialRatio ( )
virtual

Set/Get the radial ratio. This is the measure of the radius of the outer ellipsoid to the inner ellipsoid of the button. The outer ellipsoid is the boundary of the button defined by the height and width. The inner ellipsoid circumscribes the texture region. Larger RadialRatio's cause the button to be more rounded (and the texture region to be smaller); smaller ratios produce sharply curved shoulders with a larger texture region.

int vtkEllipticalButtonSource::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

double vtkEllipticalButtonSource::Width
protected

Definition at line 118 of file vtkEllipticalButtonSource.h.

double vtkEllipticalButtonSource::Height
protected

Definition at line 119 of file vtkEllipticalButtonSource.h.

double vtkEllipticalButtonSource::Depth
protected

Definition at line 120 of file vtkEllipticalButtonSource.h.

int vtkEllipticalButtonSource::CircumferentialResolution
protected

Definition at line 121 of file vtkEllipticalButtonSource.h.

int vtkEllipticalButtonSource::TextureResolution
protected

Definition at line 122 of file vtkEllipticalButtonSource.h.

int vtkEllipticalButtonSource::ShoulderResolution
protected

Definition at line 123 of file vtkEllipticalButtonSource.h.

double vtkEllipticalButtonSource::RadialRatio
protected

Definition at line 124 of file vtkEllipticalButtonSource.h.


The documentation for this class was generated from the following file: