vtkButtonRepresentation Class Reference

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

#include <vtkButtonRepresentation.h>

Inheritance diagram for vtkButtonRepresentation:

Collaboration diagram for vtkButtonRepresentation:

Public Types
enum	_InteractionState { Outside =0, Inside }
Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass
Public Types inherited from vtkProp
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	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 ()
vtkWidgetRepresentation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Pick ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
virtual void	BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void	SetVisibility (int)
virtual int	GetVisibility ()
virtual void	VisibilityOn ()
virtual void	VisibilityOff ()
virtual void	SetPickable (int)
virtual int	GetPickable ()
virtual void	PickableOn ()
virtual void	PickableOff ()
virtual void	SetDragable (int)
virtual int	GetDragable ()
virtual void	DragableOn ()
virtual void	DragableOff ()
virtual unsigned long	GetRedrawMTime ()
virtual void	SetUseBounds (bool)
virtual bool	GetUseBounds ()
virtual void	UseBoundsOn ()
virtual void	UseBoundsOff ()
virtual void	InitPathTraversal ()
virtual vtkAssemblyPath *	GetNextPath ()
virtual int	GetNumberOfPaths ()
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkMatrix4x4 *	GetMatrix ()
virtual vtkInformation *	GetPropertyKeys ()
virtual void	SetPropertyKeys (vtkInformation *keys)
virtual int	RenderOpaqueGeometry (vtkViewport *)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	RenderVolumetricGeometry (vtkViewport *)
virtual int	RenderOverlay (vtkViewport *)
virtual bool	RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool	RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
virtual double	GetEstimatedRenderTime (vtkViewport *)
virtual double	GetEstimatedRenderTime ()
virtual void	SetEstimatedRenderTime (double t)
virtual void	RestoreEstimatedRenderTime ()
virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
virtual double	GetAllocatedRenderTime ()
void	SetRenderTimeMultiplier (double t)
virtual double	GetRenderTimeMultiplier ()
virtual bool	GetSupportsSelection ()
virtual int	GetNumberOfConsumers ()
void	AddConsumer (vtkObject *c)
void	RemoveConsumer (vtkObject *c)
vtkObject *	GetConsumer (int i)
int	IsConsumer (vtkObject *c)
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

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 Member Functions inherited from vtkProp
	vtkProp ()
	~vtkProp ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

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
Protected Attributes inherited from vtkProp
int	Visibility
int	Pickable
int	Dragable
bool	UseBounds
double	AllocatedRenderTime
double	EstimatedRenderTime
double	SavedEstimatedRenderTime
double	RenderTimeMultiplier
int	NumberOfConsumers
vtkObject **	Consumers
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkWidgetRepresentation	Superclass
static int	IsTypeOf (const char *type)
static vtkButtonRepresentation *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkButtonRepresentation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const
enum	_HighlightState { HighlightNormal, HighlightHovering, HighlightSelecting }
virtual void	Highlight (int)
virtual int	GetHighlightState ()

Additional Inherited Members
Static Public Member Functions inherited from vtkWidgetRepresentation
static int	IsTypeOf (const char *type)
static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)
static vtkProp *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	GeneralTextureUnit ()
static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

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

typedef vtkWidgetRepresentation vtkButtonRepresentation::Superclass

Standard methods for the class.

Definition at line 52 of file vtkButtonRepresentation.h.

Member Enumeration Documentation

enum vtkButtonRepresentation::_InteractionState

Enumerator
Outside
Inside

Definition at line 76 of file vtkButtonRepresentation.h.

enum vtkButtonRepresentation::_HighlightState

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  )

virtual

Standard methods for the class.

Reimplemented from vtkObject.

Reimplemented in vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, and vtkProp3DButtonRepresentation.

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:

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkButtonRepresentation.h