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

abstract class defines the representation for a vtkButtonWidget More...

#include <vtkButtonRepresentation.h>

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

Public Types

enum  _InteractionState { Outside =0, Inside }
 
- Public Types inherited from vtkWidgetRepresentation
typedef vtkProp Superclass
 

Public Member Functions

virtual void ShallowCopy (vtkProp *prop)
 
virtual void SetNumberOfStates (int)
 
virtual int GetState ()
 
virtual void SetState (int state)
 
virtual void NextState ()
 
virtual void PreviousState ()
 
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void PickingManagedOn ()
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool)
 
virtual bool GetPickingManaged ()
 
virtual void SetRenderer (vtkRenderer *ren)
 
virtual vtkRenderer * GetRenderer ()
 
virtual void BuildRepresentation ()=0
 
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
 
virtual void StartWidgetInteraction (double eventPos[2])
 
virtual void WidgetInteraction (double newEventPos[2])
 
virtual void EndWidgetInteraction (double newEventPos[2])
 
virtual int ComputeInteractionState (int X, int Y, int modify=0)
 
virtual int GetInteractionState ()
 
virtual void Highlight (int vtkNotUsed(highlightOn))
 
virtual void SetPlaceFactor (double)
 
virtual double GetPlaceFactor ()
 
virtual void SetHandleSize (double)
 
virtual double GetHandleSize ()
 
virtual int GetNeedToRender ()
 
virtual void SetNeedToRender (int)
 
virtual void NeedToRenderOn ()
 
virtual void NeedToRenderOff ()
 
virtual double * GetBounds ()
 
virtual void GetActors (vtkPropCollection *)
 
virtual void GetActors2D (vtkPropCollection *)
 
virtual void GetVolumes (vtkPropCollection *)
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
virtual int RenderOverlay (vtkViewport *vtkNotUsed(viewport))
 
virtual int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))
 
virtual int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))
 
virtual int HasTranslucentPolygonalGeometry ()
 
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Protected Member Functions

 vtkButtonRepresentation ()
 
 ~vtkButtonRepresentation ()
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation ()
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
virtual void RegisterPickers ()
 
virtual void UnRegisterPickers ()
 
virtual void PickersModified ()
 
vtkPickingManager * GetPickingManager ()
 
double SizeHandlesRelativeToViewport (double factor, double pos[3])
 
double SizeHandlesInPixels (double factor, double pos[3])
 
vtkAssemblyPath * GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 

Protected Attributes

int NumberOfStates
 
int State
 
int HighlightState
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRenderer > Renderer
 
int InteractionState
 
double StartEventPosition [3]
 
double PlaceFactor
 
int Placed
 
double InitialBounds [6]
 
double InitialLength
 
int ValidPick
 
bool PickingManaged
 
double HandleSize
 
int NeedToRender
 
vtkTimeStamp BuildTime
 
typedef vtkWidgetRepresentation Superclass
 
static int IsTypeOf (const char *type)
 
static vtkButtonRepresentationSafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkButtonRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 
enum  _HighlightState { HighlightNormal, HighlightHovering, HighlightSelecting }
 
virtual void Highlight (int)
 
virtual int GetHighlightState ()
 

Detailed Description

abstract class defines the representation for a vtkButtonWidget

This abstract class is used to specify how the vtkButtonWidget should interact with representations of the vtkButtonWidget. This class may be subclassed so that alternative representations can be created. The class defines an API, and a default implementation, that the vtkButtonWidget interacts with to render itself in the scene.

The vtkButtonWidget assumes an n-state button so that traveral methods are available for changing, querying and manipulating state. Derived classed determine the actual appearance. The state is represented by an integral value 0<=state<numStates.

To use this representation, always begin by specifying the number of states. Then follow with the necessary information to represent each state (done through a subclass API).

See Also
vtkButtonWidget
Events:
vtkCommand::HighlightEvent

Definition at line 47 of file vtkButtonRepresentation.h.

Member Typedef Documentation

Standard methods for the class.

Definition at line 52 of file vtkButtonRepresentation.h.

Member Enumeration Documentation

Enumerator
Outside 
Inside 

Definition at line 76 of file vtkButtonRepresentation.h.

These methods control the appearance of the button as it is being interacted with. Subclasses will behave differently depending on their particulars. HighlightHovering is used when the mouse pointer moves over the button. HighlightSelecting is set when the button is selected. Otherwise, the HighlightNormal is used. The Highlight() method will throw a vtkCommand::HighlightEvent.

Enumerator
HighlightNormal 
HighlightHovering 
HighlightSelecting 

Definition at line 90 of file vtkButtonRepresentation.h.

Constructor & Destructor Documentation

vtkButtonRepresentation::vtkButtonRepresentation ( )
protected
vtkButtonRepresentation::~vtkButtonRepresentation ( )
protected

Member Function Documentation

static int vtkButtonRepresentation::IsTypeOf ( const char *  type)
static

Standard methods for the class.

virtual int vtkButtonRepresentation::IsA ( const char *  type)
virtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, and vtkProp3DButtonRepresentation.

static vtkButtonRepresentation* vtkButtonRepresentation::SafeDownCast ( vtkObjectBase *  o)
static

Standard methods for the class.

virtual vtkObjectBase* vtkButtonRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, and vtkProp3DButtonRepresentation.

vtkButtonRepresentation* vtkButtonRepresentation::NewInstance ( ) const

Standard methods for the class.

void vtkButtonRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

Standard methods for the class.

virtual void vtkButtonRepresentation::SetNumberOfStates ( int  )
virtual

Retrieve the current button state.

virtual int vtkButtonRepresentation::GetState ( )
virtual

Retrieve the current button state.

virtual void vtkButtonRepresentation::SetState ( int  state)
virtual

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

Reimplemented in vtkProp3DButtonRepresentation.

virtual void vtkButtonRepresentation::NextState ( )
virtual

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

virtual void vtkButtonRepresentation::PreviousState ( )
virtual

Manipulate the state. Note that the NextState() and PreviousState() methods use modulo traveral. The "state" integral value will be clamped within the possible state values (0<=state<NumberOfStates). Note that subclasses will override these methods in many cases.

virtual void vtkButtonRepresentation::Highlight ( int  )
virtual

These methods control the appearance of the button as it is being interacted with. Subclasses will behave differently depending on their particulars. HighlightHovering is used when the mouse pointer moves over the button. HighlightSelecting is set when the button is selected. Otherwise, the HighlightNormal is used. The Highlight() method will throw a vtkCommand::HighlightEvent.

Reimplemented in vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.

virtual int vtkButtonRepresentation::GetHighlightState ( )
virtual

These methods control the appearance of the button as it is being interacted with. Subclasses will behave differently depending on their particulars. HighlightHovering is used when the mouse pointer moves over the button. HighlightSelecting is set when the button is selected. Otherwise, the HighlightNormal is used. The Highlight() method will throw a vtkCommand::HighlightEvent.

virtual void vtkButtonRepresentation::ShallowCopy ( vtkProp *  prop)
virtual

Satisfy some of vtkProp's API.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, and vtkProp3DButtonRepresentation.

Member Data Documentation

int vtkButtonRepresentation::NumberOfStates
protected

Definition at line 103 of file vtkButtonRepresentation.h.

int vtkButtonRepresentation::State
protected

Definition at line 104 of file vtkButtonRepresentation.h.

int vtkButtonRepresentation::HighlightState
protected

Definition at line 105 of file vtkButtonRepresentation.h.


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