defines a representation for a vtkButtonWidget More...
#include <vtkTexturedButtonRepresentation.h>
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
Definition at line 66 of file vtkTexturedButtonRepresentation.h.
Member Typedef Documentation
Standard methods for instances of the class.
Reimplemented from vtkButtonRepresentation.
Definition at line 74 of file vtkTexturedButtonRepresentation.h.
Constructor & Destructor Documentation
| vtkTexturedButtonRepresentation::vtkTexturedButtonRepresentation | ( | ) | [protected] |
Member Function Documentation
| static vtkTexturedButtonRepresentation* vtkTexturedButtonRepresentation::New | ( | ) | [static] |
Instantiate the class.
Reimplemented from vtkObject.
| static int vtkTexturedButtonRepresentation::IsTypeOf | ( | const char * | type | ) | [static] |
Standard methods for instances of the class.
Reimplemented from vtkButtonRepresentation.
| 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.
Reimplemented from vtkButtonRepresentation.
| virtual vtkObjectBase* vtkTexturedButtonRepresentation::NewInstanceInternal | ( | ) | const [protected, virtual] |
Standard methods for instances of the class.
Reimplemented from vtkButtonRepresentation.
Standard methods for instances of the class.
Reimplemented from vtkButtonRepresentation.
| void vtkTexturedButtonRepresentation::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Standard methods for instances of the class.
Reimplemented from vtkButtonRepresentation.
Set/Get the polydata which defines the button geometry.
| void vtkTexturedButtonRepresentation::SetButtonGeometryConnection | ( | vtkAlgorithmOutput * | algOutput | ) |
Set/Get the polydata which defines the button geometry.
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).
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.
Reimplemented from vtkProp.
| virtual int vtkTexturedButtonRepresentation::RenderTranslucentPolygonalGeometry | ( | vtkViewport * | ) | [virtual] |
Provide the necessary methods to satisfy the rendering API.
Reimplemented from vtkProp.
| 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 | ( | ) | [protected, virtual] |
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.
Definition at line 162 of file vtkTexturedButtonRepresentation.h.
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:
- dox/Interaction/Widgets/vtkTexturedButtonRepresentation.h
