defines a representation for a vtkButtonWidget More...

#include <vtkTexturedButtonRepresentation.h>

Inheritance diagram for vtkTexturedButtonRepresentation:

Collaboration diagram for vtkTexturedButtonRepresentation:

Public Member Functions
virtual void	PlaceWidget (double scale, double point[3], double normal[3])
	Alternative method for placing a button at a given position (defined by point[3]); at a given orientation (normal[3], where the z-axis of the button geometry is parallel to the normal); and scaled by the scale parameter. More...


void	SetButtonGeometry (vtkPolyData *pd)
	Set/Get the polydata which defines the button geometry. More...

void	SetButtonGeometryConnection (vtkAlgorithmOutput *algOutput)
	Set/Get the polydata which defines the button geometry. More...

vtkPolyData *	GetButtonGeometry ()
	Set/Get the polydata which defines the button geometry. More...


virtual void	SetFollowCamera (int)
	Specify whether the button should always face the camera. More...

virtual int	GetFollowCamera ()
	Specify whether the button should always face the camera. More...

virtual void	FollowCameraOn ()
	Specify whether the button should always face the camera. More...

virtual void	FollowCameraOff ()
	Specify whether the button should always face the camera. More...


virtual void	SetProperty (vtkProperty *p)
	Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button. More...

virtual vtkProperty *	GetProperty ()
	Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button. More...


virtual void	SetHoveringProperty (vtkProperty *p)
	Specify the property to use when the hovering over the button. More...

virtual vtkProperty *	GetHoveringProperty ()
	Specify the property to use when the hovering over the button. More...


virtual void	SetSelectingProperty (vtkProperty *p)
	Specify the property to use when selecting the button. More...

virtual vtkProperty *	GetSelectingProperty ()
	Specify the property to use when selecting the button. More...


void	SetButtonTexture (int i, vtkImageData *image)
	Add the ith texture corresponding to the ith button state. More...

vtkImageData *	GetButtonTexture (int i)
	Add the ith texture corresponding to the ith button state. More...


virtual int	ComputeInteractionState (int X, int Y, int modify=0)
	Provide the necessary methods to satisfy the vtkWidgetRepresentation API. More...

virtual void	PlaceWidget (double bounds[6])
	Provide the necessary methods to satisfy the vtkWidgetRepresentation API. More...

virtual void	BuildRepresentation ()
	Provide the necessary methods to satisfy the vtkWidgetRepresentation API. More...

virtual void	Highlight (int state)
	Provide the necessary methods to satisfy the vtkWidgetRepresentation API. More...


virtual void	ShallowCopy (vtkProp *prop)
	Provide the necessary methods to satisfy the rendering API. More...

virtual double *	GetBounds ()
	Provide the necessary methods to satisfy the rendering API. More...

virtual void	GetActors (vtkPropCollection *pc)
	Provide the necessary methods to satisfy the rendering API. More...

virtual void	ReleaseGraphicsResources (vtkWindow *)
	Provide the necessary methods to satisfy the rendering API. More...

virtual int	RenderOpaqueGeometry (vtkViewport *)
	Provide the necessary methods to satisfy the rendering API. More...

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
	Provide the necessary methods to satisfy the rendering API. More...

virtual int	HasTranslucentPolygonalGeometry ()
	Provide the necessary methods to satisfy the rendering API. More...

Public Member Functions inherited from vtkButtonRepresentation
virtual void	SetNumberOfStates (int)
	Retrieve the current button state. More...

virtual int	GetState ()
	Retrieve the current button state. More...

virtual void	SetState (int state)
	Manipulate the state. More...

virtual void	NextState ()
	Manipulate the state. More...

virtual void	PreviousState ()
	Manipulate the state. More...

vtkButtonRepresentation *	NewInstance () const
	Standard methods for the class. More...

virtual int	GetHighlightState ()
	These methods control the appearance of the button as it is being interacted with. More...

Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PlaceWidget (double *vtkNotUsed(bounds[6]))
	The following is a suggested API for widget representations. More...

virtual void	StartWidgetInteraction (double eventPos[2])

virtual void	WidgetInteraction (double newEventPos[2])

virtual void	EndWidgetInteraction (double newEventPos[2])

virtual int	GetInteractionState ()

virtual void	Highlight (int vtkNotUsed(highlightOn))

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

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 void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	SetPickingManaged (bool)
	Enable/Disable the use of a manager to process the picking. More...

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	SetRenderer (vtkRenderer *ren)
	Subclasses of vtkWidgetRepresentation must implement these methods. More...

virtual vtkRenderer *	GetRenderer ()
	Subclasses of vtkWidgetRepresentation must implement these methods. More...

virtual void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...

virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...

virtual int	GetNeedToRender ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...

virtual void	SetNeedToRender (int)
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...

virtual void	NeedToRenderOn ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...

virtual void	NeedToRenderOff ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...

vtkWidgetRepresentation *	NewInstance () const
	Standard methods for instances of this class. More...

void	PrintSelf (ostream &os, vtkIndent indent)
	Standard methods for instances of this class. More...

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Pick ()
	Method fires PickEvent if the prop is picked. More...

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently. More...

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys. More...

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys. More...

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...

virtual void	SetVisibility (int)
	Set/Get visibility of this vtkProp. More...

virtual int	GetVisibility ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp. More...

virtual void	SetPickable (int)
	Set/Get the pickable instance variable. More...

virtual int	GetPickable ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOn ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOff ()
	Set/Get the pickable instance variable. More...

virtual void	SetDragable (int)
	Set/Get the value of the dragable instance variable. More...

virtual int	GetDragable ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable. More...

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys. More...

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys. More...

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

virtual int	GetNumberOfConsumers ()
	Get the number of consumers. More...

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,. More...

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTexturedButtonRepresentation *	New ()
	Instantiate the class. More...

Static Public Member Functions inherited from vtkButtonRepresentation
static int	IsTypeOf (const char *type)
	Standard methods for the class. More...

static vtkButtonRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for the class. More...

Static Public Member Functions inherited from vtkWidgetRepresentation
static int	IsTypeOf (const char *type)
	Standard methods for instances of this class. More...

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class. More...

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
	vtkTexturedButtonRepresentation ()

	~vtkTexturedButtonRepresentation ()

void	CreateDefaultProperties ()

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

Protected Member Functions inherited from vtkButtonRepresentation
	vtkButtonRepresentation ()

	~vtkButtonRepresentation ()

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation ()

void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])

virtual void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...

virtual void	PickersModified ()
	Update the pickers registered in the Picking Manager when pickers are modified. More...

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the widget representation currently belong. More...

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. More...

double	SizeHandlesRelativeToViewport (double factor, double pos[3])

double	SizeHandlesInPixels (double factor, double pos[3])

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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
vtkActor *	Actor

vtkFollower *	Follower

vtkPolyDataMapper *	Mapper

vtkTexture *	Texture

int	FollowCamera

vtkProperty *	Property

vtkProperty *	HoveringProperty

vtkProperty *	SelectingProperty

vtkTextureArray *	TextureArray

vtkCellPicker *	Picker

Protected Attributes inherited from vtkButtonRepresentation
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 vtkButtonRepresentation	Superclass
	Standard methods for instances of the class. More...

static int	IsTypeOf (const char *type)
	Standard methods for instances of the class. More...

static vtkTexturedButtonRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of the class. More...

virtual int	IsA (const char *type)
	Standard methods for instances of the class. More...

vtkTexturedButtonRepresentation *	NewInstance () const
	Standard methods for instances of the class. More...

void	PrintSelf (ostream &os, vtkIndent indent)
	Standard methods for instances of the class. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instances of the class. More...

Additional Inherited Members
Public Types inherited from vtkButtonRepresentation
enum	_InteractionState { Outside =0, Inside }

typedef vtkWidgetRepresentation	Superclass
	Standard methods for the class. More...

enum	_HighlightState { HighlightNormal, HighlightHovering, HighlightSelecting }
	These methods control the appearance of the button as it is being interacted with. More...

Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass
	Standard methods for instances of this class. More...

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Detailed Description

defines a representation for a vtkButtonWidget

This class implements one type of vtkButtonRepresentation. It changes the appearance of a user-provided polydata by assigning textures according to the current button state. It also provides highlighting (when hovering and selecting the button) by fiddling with the actor's property.

To use this representation, always begin by specifying the number of button states. Then provide a polydata (the polydata should have associated texture coordinates), and a list of textures cooresponding to the button states. Optionally, the HoveringProperty and SelectionProperty can be adjusted to obtain the appropriate appearance.

This widget representation has two placement methods. The conventional PlaceWidget() method is used to locate the textured button inside of a user-specified bounding box (note that the button geometry is uniformly scaled to fit, thus two of the three dimensions can be "large" and the third used to perform the scaling). However this PlaceWidget() method will align the geometry within x-y-z oriented bounds. To further control the placement, use the additional PlaceWidget(scale,point,normal) method. This scales the geometry, places its center at the specified point position, and orients the geometry's z-direction parallel to the specified normal. This can be used to attach "sticky notes" or "sticky buttons" to the surface of objects.

See also: vtkButtonWidget vtkButtonRepresentation vtkButtonSource vtkEllipticalButtonSource vtkRectangularButtonSource

Tests:: vtkTexturedButtonRepresentation (Tests)

Definition at line 67 of file vtkTexturedButtonRepresentation.h.

Member Typedef Documentation

typedef vtkButtonRepresentation vtkTexturedButtonRepresentation::Superclass

Standard methods for instances of the class.

Definition at line 79 of file vtkTexturedButtonRepresentation.h.

Constructor & Destructor Documentation

vtkTexturedButtonRepresentation::vtkTexturedButtonRepresentation ( )

protected

vtkTexturedButtonRepresentation::~vtkTexturedButtonRepresentation ( )

protected

Member Function Documentation

static vtkTexturedButtonRepresentation* vtkTexturedButtonRepresentation::New ( )

static

Instantiate the class.

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

static

Standard methods for instances of the class.

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

virtual

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

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

static

Standard methods for instances of the class.

virtual vtkObjectBase* vtkTexturedButtonRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

vtkTexturedButtonRepresentation* vtkTexturedButtonRepresentation::NewInstance ( ) const

Standard methods for instances of the class.

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

virtual

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

void vtkTexturedButtonRepresentation::SetButtonGeometry ( vtkPolyData * pd )

Set/Get the polydata which defines the button geometry.

void vtkTexturedButtonRepresentation::SetButtonGeometryConnection ( vtkAlgorithmOutput * algOutput )

Set/Get the polydata which defines the button geometry.

vtkPolyData* vtkTexturedButtonRepresentation::GetButtonGeometry ( )

Set/Get the polydata which defines the button geometry.

virtual void vtkTexturedButtonRepresentation::SetFollowCamera ( int )

virtual

Specify whether the button should always face the camera.

If enabled, the button rotates as the camera moves.

virtual int vtkTexturedButtonRepresentation::GetFollowCamera ( )

virtual

Specify whether the button should always face the camera.

If enabled, the button rotates as the camera moves.

virtual void vtkTexturedButtonRepresentation::FollowCameraOn ( )

virtual

Specify whether the button should always face the camera.

If enabled, the button rotates as the camera moves.

virtual void vtkTexturedButtonRepresentation::FollowCameraOff ( )

virtual

Specify whether the button should always face the camera.

If enabled, the button rotates as the camera moves.

virtual void vtkTexturedButtonRepresentation::SetProperty ( vtkProperty * p )

virtual

Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button.

virtual vtkProperty* vtkTexturedButtonRepresentation::GetProperty ( )

virtual

Specify the property to use when the button is to appear "normal" i.e., the mouse pointer is not hovering or selecting the button.

virtual void vtkTexturedButtonRepresentation::SetHoveringProperty ( vtkProperty * p )

virtual

Specify the property to use when the hovering over the button.

virtual vtkProperty* vtkTexturedButtonRepresentation::GetHoveringProperty ( )

virtual

Specify the property to use when the hovering over the button.

virtual void vtkTexturedButtonRepresentation::SetSelectingProperty ( vtkProperty * p )

virtual

Specify the property to use when selecting the button.

virtual vtkProperty* vtkTexturedButtonRepresentation::GetSelectingProperty ( )

virtual

Specify the property to use when selecting the button.

void vtkTexturedButtonRepresentation::SetButtonTexture	(	int	i,
		vtkImageData *	image
	)

Add the ith texture corresponding to the ith button state.

The parameter i should be (0 <= i < NumberOfStates).

vtkImageData* vtkTexturedButtonRepresentation::GetButtonTexture ( int i )

Add the ith texture corresponding to the ith button state.

The parameter i should be (0 <= i < NumberOfStates).

virtual void vtkTexturedButtonRepresentation::PlaceWidget	(	double	scale,
		double	point[3],
		double	normal[3]
	)

virtual

Alternative method for placing a button at a given position (defined by point[3]); at a given orientation (normal[3], where the z-axis of the button geometry is parallel to the normal); and scaled by the scale parameter.

This method can bs used to attach "sticky notes" or "sticky buttons" to objects. A great way to attach interactive meta-data to 3D actors.