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

defines a representation for a vtkButtonWidget More...

#include <vtkTexturedButtonRepresentation.h>

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

Public Member Functions

virtual void PlaceWidget (double scale, double point[3], double normal[3])
 
void SetButtonGeometry (vtkPolyData *pd)
 
void SetButtonGeometryConnection (vtkAlgorithmOutput *algOutput)
 
vtkPolyDataGetButtonGeometry ()
 
virtual void SetFollowCamera (int)
 
virtual int GetFollowCamera ()
 
virtual void FollowCameraOn ()
 
virtual void FollowCameraOff ()
 
virtual void SetProperty (vtkProperty *p)
 
virtual vtkProperty * GetProperty ()
 
virtual void SetHoveringProperty (vtkProperty *p)
 
virtual vtkProperty * GetHoveringProperty ()
 
virtual void SetSelectingProperty (vtkProperty *p)
 
virtual vtkProperty * GetSelectingProperty ()
 
void SetButtonTexture (int i, vtkImageData *image)
 
vtkImageData * GetButtonTexture (int i)
 
virtual int ComputeInteractionState (int X, int Y, int modify=0)
 
virtual void PlaceWidget (double bounds[6])
 
virtual void BuildRepresentation ()
 
virtual void Highlight (int state)
 
virtual void ShallowCopy (vtkProp *prop)
 
virtual double * GetBounds ()
 
virtual void GetActors (vtkPropCollection *pc)
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int HasTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkButtonRepresentation
virtual void SetNumberOfStates (int)
 
virtual int GetState ()
 
virtual void SetState (int state)
 
virtual void NextState ()
 
virtual void PreviousState ()
 
vtkButtonRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetHighlightState ()
 
- 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 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 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 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))
 
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static
vtkTexturedButtonRepresentation
New ()
 
- Static Public Member Functions inherited from vtkButtonRepresentation
static int IsTypeOf (const char *type)
 
static vtkButtonRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static int IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

 vtkTexturedButtonRepresentation ()
 
 ~vtkTexturedButtonRepresentation ()
 
void CreateDefaultProperties ()
 
virtual void RegisterPickers ()
 
- 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 ()
 
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

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
 
typedef vtkButtonRepresentation Superclass
 
static int IsTypeOf (const char *type)
 
static
vtkTexturedButtonRepresentation
SafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkTexturedButtonRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkObjectBase * NewInstanceInternal () const
 

Additional Inherited Members

- Public Types inherited from vtkButtonRepresentation
enum  _InteractionState { Outside =0, Inside }
 
typedef vtkWidgetRepresentation Superclass
 
enum  _HighlightState { HighlightNormal, HighlightHovering, HighlightSelecting }
 
- Public Types inherited from vtkWidgetRepresentation
typedef vtkProp 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 66 of file vtkTexturedButtonRepresentation.h.

Member Typedef Documentation

Standard methods for instances of the class.

Definition at line 74 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 
)

Standard methods for instances of the class.

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.

virtual int vtkTexturedButtonRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
)
virtual

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkTexturedButtonRepresentation::PlaceWidget ( double  bounds[6])
virtual

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

virtual void vtkTexturedButtonRepresentation::BuildRepresentation ( )
virtual

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Implements vtkWidgetRepresentation.

virtual void vtkTexturedButtonRepresentation::Highlight ( int  state)
virtual

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from vtkButtonRepresentation.

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

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkButtonRepresentation.

virtual double* vtkTexturedButtonRepresentation::GetBounds ( )
virtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkTexturedButtonRepresentation::GetActors ( vtkPropCollection *  pc)
virtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkTexturedButtonRepresentation::ReleaseGraphicsResources ( vtkWindow *  )
virtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkTexturedButtonRepresentation::RenderOpaqueGeometry ( vtkViewport *  )
virtual

Provide the necessary methods to satisfy the rendering API.

virtual int vtkTexturedButtonRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport *  )
virtual

Provide the necessary methods to satisfy the rendering API.

virtual int vtkTexturedButtonRepresentation::HasTranslucentPolygonalGeometry ( )
virtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

void vtkTexturedButtonRepresentation::CreateDefaultProperties ( )
protected
virtual void vtkTexturedButtonRepresentation::RegisterPickers ( )
protectedvirtual

Register internal Pickers in the Picking Manager. Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

Member Data Documentation

vtkActor* vtkTexturedButtonRepresentation::Actor
protected

Definition at line 152 of file vtkTexturedButtonRepresentation.h.

vtkFollower* vtkTexturedButtonRepresentation::Follower
protected

Definition at line 153 of file vtkTexturedButtonRepresentation.h.

vtkPolyDataMapper* vtkTexturedButtonRepresentation::Mapper
protected

Definition at line 154 of file vtkTexturedButtonRepresentation.h.

vtkTexture* vtkTexturedButtonRepresentation::Texture
protected

Definition at line 155 of file vtkTexturedButtonRepresentation.h.

int vtkTexturedButtonRepresentation::FollowCamera
protected

Definition at line 158 of file vtkTexturedButtonRepresentation.h.

vtkProperty* vtkTexturedButtonRepresentation::Property
protected

Definition at line 161 of file vtkTexturedButtonRepresentation.h.

vtkProperty* vtkTexturedButtonRepresentation::HoveringProperty
protected

Definition at line 162 of file vtkTexturedButtonRepresentation.h.

vtkProperty* vtkTexturedButtonRepresentation::SelectingProperty
protected

Definition at line 163 of file vtkTexturedButtonRepresentation.h.

vtkTextureArray* vtkTexturedButtonRepresentation::TextureArray
protected

Definition at line 168 of file vtkTexturedButtonRepresentation.h.

vtkCellPicker* vtkTexturedButtonRepresentation::Picker
protected

Definition at line 171 of file vtkTexturedButtonRepresentation.h.


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