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
vtkProp3DButtonRepresentation Class Reference

defines a representation for a vtkButtonWidget More...

#include <vtkProp3DButtonRepresentation.h>

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

Public Member Functions

virtual void SetState (int state)
 
virtual void PlaceWidget (double bounds[6])
 
void SetButtonProp (int i, vtkProp3D *prop)
 
vtkProp3D * GetButtonProp (int i)
 
virtual void SetFollowCamera (int)
 
virtual int GetFollowCamera ()
 
virtual void FollowCameraOn ()
 
virtual void FollowCameraOff ()
 
virtual int ComputeInteractionState (int X, int Y, int modify=0)
 
virtual void BuildRepresentation ()
 
virtual void ShallowCopy (vtkProp *prop)
 
virtual double * GetBounds ()
 
virtual void GetActors (vtkPropCollection *pc)
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (vtkViewport *)
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int HasTranslucentPolygonalGeometry ()
 
- Public Member Functions inherited from vtkButtonRepresentation
virtual void SetNumberOfStates (int)
 
virtual int GetState ()
 
virtual void NextState ()
 
virtual void PreviousState ()
 
vtkButtonRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Highlight (int)
 
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
vtkProp3DButtonRepresentation
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

 vtkProp3DButtonRepresentation ()
 
 ~vtkProp3DButtonRepresentation ()
 
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

vtkProp3D * CurrentProp
 
vtkProp3DFollower * Follower
 
int FollowCamera
 
vtkPropArray * PropArray
 
vtkPropPicker * 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
vtkProp3DButtonRepresentation
SafeDownCast (vtkObjectBase *o)
 
virtual int IsA (const char *type)
 
vtkProp3DButtonRepresentationNewInstance () 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. Each button state can be represented with a separate instance of vtkProp3D. Thus buttons can be represented with vtkActor, vtkImageActor, volumes (e.g., vtkVolume) and/or any other vtkProp3D. Also, the class invokes events when highlighting occurs (i.e., hovering, selecting) so that appropriate action can be taken to highlight the button (if desired).

To use this representation, always begin by specifying the number of button states. Then provide, for each state, an instance of vtkProp3D.

This widget representation uses the conventional placement method. The button is placed inside the bounding box defined by PlaceWidget by translating and scaling the vtkProp3D to fit (each vtkProp3D is transformed). Therefore, you must define the number of button states and each state (i.e., vtkProp3D) prior to calling vtkPlaceWidget.

See Also
vtkButtonWidget vtkButtonRepresentation vtkButtonSource vtkEllipticalButtonSource vtkRectangularButtonSource
Tests:
vtkProp3DButtonRepresentation (Tests)

Definition at line 53 of file vtkProp3DButtonRepresentation.h.

Member Typedef Documentation

Standard methods for instances of the class.

Definition at line 61 of file vtkProp3DButtonRepresentation.h.

Constructor & Destructor Documentation

vtkProp3DButtonRepresentation::vtkProp3DButtonRepresentation ( )
protected
vtkProp3DButtonRepresentation::~vtkProp3DButtonRepresentation ( )
protected

Member Function Documentation

static vtkProp3DButtonRepresentation* vtkProp3DButtonRepresentation::New ( )
static

Instantiate the class.

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

Standard methods for instances of the class.

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

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

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

Standard methods for instances of the class.

virtual vtkObjectBase* vtkProp3DButtonRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instances of the class.

Reimplemented from vtkButtonRepresentation.

vtkProp3DButtonRepresentation* vtkProp3DButtonRepresentation::NewInstance ( ) const

Standard methods for instances of the class.

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

Standard methods for instances of the class.

void vtkProp3DButtonRepresentation::SetButtonProp ( int  i,
vtkProp3D *  prop 
)

Add the ith texture corresponding to the ith button state. The parameter i should be (0 <= i < NumberOfStates).

vtkProp3D* vtkProp3DButtonRepresentation::GetButtonProp ( int  i)

Add the ith texture corresponding to the ith button state. The parameter i should be (0 <= i < NumberOfStates).

virtual void vtkProp3DButtonRepresentation::SetFollowCamera ( int  )
virtual

Specify whether the button should always face the camera. If enabled, the button reorients itself towards the camera as the camera moves.

virtual int vtkProp3DButtonRepresentation::GetFollowCamera ( )
virtual

Specify whether the button should always face the camera. If enabled, the button reorients itself towards the camera as the camera moves.

virtual void vtkProp3DButtonRepresentation::FollowCameraOn ( )
virtual

Specify whether the button should always face the camera. If enabled, the button reorients itself towards the camera as the camera moves.

virtual void vtkProp3DButtonRepresentation::FollowCameraOff ( )
virtual

Specify whether the button should always face the camera. If enabled, the button reorients itself towards the camera as the camera moves.

virtual void vtkProp3DButtonRepresentation::SetState ( int  state)
virtual

Extend the vtkButtonRepresentation::SetState() method.

Reimplemented from vtkButtonRepresentation.

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

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkProp3DButtonRepresentation::BuildRepresentation ( )
virtual

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Implements vtkWidgetRepresentation.

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

This method positions (translates and scales the props) into the bounding box specified. Note all the button props are scaled.

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

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkButtonRepresentation.

virtual double* vtkProp3DButtonRepresentation::GetBounds ( )
virtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

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

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkProp3DButtonRepresentation::ReleaseGraphicsResources ( vtkWindow *  )
virtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkProp3DButtonRepresentation::RenderOpaqueGeometry ( vtkViewport *  )
virtual

Provide the necessary methods to satisfy the rendering API.

virtual int vtkProp3DButtonRepresentation::RenderVolumetricGeometry ( vtkViewport *  )
virtual

Provide the necessary methods to satisfy the rendering API.

virtual int vtkProp3DButtonRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport *  )
virtual

Provide the necessary methods to satisfy the rendering API.

virtual int vtkProp3DButtonRepresentation::HasTranslucentPolygonalGeometry ( )
virtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkProp3DButtonRepresentation::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

vtkProp3D* vtkProp3DButtonRepresentation::CurrentProp
protected

Definition at line 111 of file vtkProp3DButtonRepresentation.h.

vtkProp3DFollower* vtkProp3DButtonRepresentation::Follower
protected

Definition at line 114 of file vtkProp3DButtonRepresentation.h.

int vtkProp3DButtonRepresentation::FollowCamera
protected

Definition at line 115 of file vtkProp3DButtonRepresentation.h.

vtkPropArray* vtkProp3DButtonRepresentation::PropArray
protected

Definition at line 119 of file vtkProp3DButtonRepresentation.h.

vtkPropPicker* vtkProp3DButtonRepresentation::Picker
protected

Definition at line 122 of file vtkProp3DButtonRepresentation.h.


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