VTK
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTexturedButtonRepresentation2D Class Reference

defines a representation for a vtkButtonWidget More...

#include <vtkTexturedButtonRepresentation2D.h>

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

Public Member Functions

vtkBalloonRepresentationGetBalloon ()
 Grab the underlying vtkBalloonRepresentation used to position and display the button texture. More...
 
void PlaceWidget (double bounds[6]) override
 Conventional PlaceWidget() method to satisfy the vtkWidgetRepresentation API. More...
 
virtual void PlaceWidget (double anchor[3], int size[2])
 This alternative PlaceWidget() method can be used to anchor the button to a 3D point. More...
 
virtual void SetProperty (vtkProperty2D *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 vtkProperty2DGetProperty ()
 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 (vtkProperty2D *p)
 Specify the property to use when the hovering over the button. More...
 
virtual vtkProperty2DGetHoveringProperty ()
 Specify the property to use when the hovering over the button. More...
 
virtual void SetSelectingProperty (vtkProperty2D *p)
 Specify the property to use when selecting the button. More...
 
virtual vtkProperty2DGetSelectingProperty ()
 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...
 
vtkImageDataGetButtonTexture (int i)
 Add the ith texture corresponding to the ith button state. More...
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 Provide the necessary methods to satisfy the vtkWidgetRepresentation API. More...
 
void BuildRepresentation () override
 Provide the necessary methods to satisfy the vtkWidgetRepresentation API. More...
 
void Highlight (int state) override
 Provide the necessary methods to satisfy the vtkWidgetRepresentation API. More...
 
void ShallowCopy (vtkProp *prop) override
 Provide the necessary methods to satisfy the rendering API. More...
 
doubleGetBounds () override
 Provide the necessary methods to satisfy the rendering API. More...
 
void GetActors (vtkPropCollection *pc) override
 Provide the necessary methods to satisfy the rendering API. More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Provide the necessary methods to satisfy the rendering API. More...
 
int RenderOverlay (vtkViewport *) override
 Provide the necessary methods to satisfy the rendering API. More...
 
int HasTranslucentPolygonalGeometry () override
 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...
 
vtkButtonRepresentationNewInstance () const
 Standard methods for the class. More...
 
void Highlight (int) override
 These methods control the appearance of the button as it is being interacted with. 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))
 
doubleGetBounds () override
 Methods to make this class behave as a vtkProp. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
void GetActors2D (vtkPropCollection *) override
 
void GetVolumes (vtkPropCollection *) override
 
void ReleaseGraphicsResources (vtkWindow *) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...
 
int RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override
 
int HasTranslucentPolygonalGeometry () override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...
 
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 vtkRendererGetRenderer ()
 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...
 
vtkWidgetRepresentationNewInstance () const
 Standard methods for instances of this class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instances of this class. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 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 vtkMatrix4x4GetMatrix ()
 
virtual bool HasKeys (vtkInformation *requiredKeys)
 Tells if the prop has all the required keys. More...
 
virtual int RenderOpaqueGeometry (vtkViewport *)
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More...
 
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
 
virtual int RenderVolumetricGeometry (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 vtkAssemblyPathGetNextPath ()
 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 vtkInformationGetPropertyKeys ()
 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...
 
vtkObjectGetConsumer (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...
 
vtkCommandGetCommand (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 vtkTexturedButtonRepresentation2DNew ()
 Instantiate the class. More...
 
- Static Public Member Functions inherited from vtkButtonRepresentation
static int IsTypeOf (const char *type)
 Standard methods for the class. More...
 
static vtkButtonRepresentationSafeDownCast (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 vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class. More...
 
- Static Public Member Functions inherited from vtkProp
static int IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 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 vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

 vtkTexturedButtonRepresentation2D ()
 
 ~vtkTexturedButtonRepresentation2D () override
 
void CreateDefaultProperties ()
 
- Protected Member Functions inherited from vtkButtonRepresentation
 vtkButtonRepresentation ()
 
 ~vtkButtonRepresentation () override
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
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...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (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 () override
 
- 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=nullptr)
 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

vtkBalloonRepresentationBalloon
 
vtkProperty2DProperty
 
vtkProperty2DHoveringProperty
 
vtkProperty2DSelectingProperty
 
vtkTextureArray * TextureArray
 
vtkCoordinateAnchor
 
- Protected Attributes inherited from vtkButtonRepresentation
int NumberOfStates
 
int State
 
int HighlightState
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRendererRenderer
 
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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
- 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 the class. More...
 
static int IsTypeOf (const char *type)
 Standard methods for the class. More...
 
static vtkTexturedButtonRepresentation2DSafeDownCast (vtkObjectBase *o)
 Standard methods for the class. More...
 
virtual int IsA (const char *type)
 Standard methods for the class. More...
 
vtkTexturedButtonRepresentation2DNewInstance () const
 Standard methods for the class. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for the class. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for 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. Since this is a 2D version, the button is rendered in the overlay plane. Typically it is positioned in display coordinates, but it can be anchored to a world position so it will appear to move as the camera moves.

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.

Warning
There are two variants of the PlaceWidget() method. The first PlaceWidget(bds[6]) allows the widget to be placed in the display coordinates fixed to the overlay plane. The second PlaceWidget(anchor[3],size[2]) places the widget in world space; hence it will appear to move as the camera moves around the scene.
See also
vtkButtonWidget vtkButtonRepresentation vtkTexturedButtonRepresentation vtkProp3DButtonRepresentation
Tests:
vtkTexturedButtonRepresentation2D (Tests)

Definition at line 62 of file vtkTexturedButtonRepresentation2D.h.

Member Typedef Documentation

Standard methods for the class.

Definition at line 74 of file vtkTexturedButtonRepresentation2D.h.

Constructor & Destructor Documentation

vtkTexturedButtonRepresentation2D::vtkTexturedButtonRepresentation2D ( )
protected
vtkTexturedButtonRepresentation2D::~vtkTexturedButtonRepresentation2D ( )
overrideprotected

Member Function Documentation

static vtkTexturedButtonRepresentation2D* vtkTexturedButtonRepresentation2D::New ( )
static

Instantiate the class.

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

Standard methods for the class.

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

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

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

Standard methods for the class.

virtual vtkObjectBase* vtkTexturedButtonRepresentation2D::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

vtkTexturedButtonRepresentation2D* vtkTexturedButtonRepresentation2D::NewInstance ( ) const

Standard methods for the class.

void vtkTexturedButtonRepresentation2D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard methods for the class.

Reimplemented from vtkButtonRepresentation.

virtual void vtkTexturedButtonRepresentation2D::SetProperty ( vtkProperty2D 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 vtkProperty2D* vtkTexturedButtonRepresentation2D::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 vtkTexturedButtonRepresentation2D::SetHoveringProperty ( vtkProperty2D p)
virtual

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

virtual vtkProperty2D* vtkTexturedButtonRepresentation2D::GetHoveringProperty ( )
virtual

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

virtual void vtkTexturedButtonRepresentation2D::SetSelectingProperty ( vtkProperty2D p)
virtual

Specify the property to use when selecting the button.

virtual vtkProperty2D* vtkTexturedButtonRepresentation2D::GetSelectingProperty ( )
virtual

Specify the property to use when selecting the button.

void vtkTexturedButtonRepresentation2D::SetButtonTexture ( int  i,
vtkImageData image 
)

Add the ith texture corresponding to the ith button state.

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

vtkImageData* vtkTexturedButtonRepresentation2D::GetButtonTexture ( int  i)

Add the ith texture corresponding to the ith button state.

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

vtkBalloonRepresentation* vtkTexturedButtonRepresentation2D::GetBalloon ( )
inline

Grab the underlying vtkBalloonRepresentation used to position and display the button texture.

Definition at line 116 of file vtkTexturedButtonRepresentation2D.h.

int vtkTexturedButtonRepresentation2D::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
)
overridevirtual

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Reimplemented from vtkWidgetRepresentation.

void vtkTexturedButtonRepresentation2D::BuildRepresentation ( )
overridevirtual

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

Implements vtkWidgetRepresentation.

void vtkTexturedButtonRepresentation2D::Highlight ( int  state)
override

Provide the necessary methods to satisfy the vtkWidgetRepresentation API.

void vtkTexturedButtonRepresentation2D::PlaceWidget ( double  bounds[6])
override

Conventional PlaceWidget() method to satisfy the vtkWidgetRepresentation API.

In this version, bounds[6] specifies a rectangle in display coordinates in which to place the button. The values for bounds[4] and bounds[5] can be set to zero. Note that PlaceWidget() is typically called at the end of configuring the button representation.

virtual void vtkTexturedButtonRepresentation2D::PlaceWidget ( double  anchor[3],
int  size[2] 
)
virtual

This alternative PlaceWidget() method can be used to anchor the button to a 3D point.

In this case, the button representation will move around the screen as the camera moves around the world space. The first parameter anchor[3] is the world point anchor position (attached to the lower left portion of the button by default); and the size[2] parameter defines a x-y box in display coordinates in which the button will fit. Note that you can grab the vtkBalloonRepresentation and set an offset value if the anchor point is to be elsewhere on the button.

void vtkTexturedButtonRepresentation2D::ShallowCopy ( vtkProp prop)
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkButtonRepresentation.

double* vtkTexturedButtonRepresentation2D::GetBounds ( )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

void vtkTexturedButtonRepresentation2D::GetActors ( vtkPropCollection pc)
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

void vtkTexturedButtonRepresentation2D::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

int vtkTexturedButtonRepresentation2D::RenderOverlay ( vtkViewport )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

int vtkTexturedButtonRepresentation2D::HasTranslucentPolygonalGeometry ( )
overridevirtual

Provide the necessary methods to satisfy the rendering API.

Reimplemented from vtkProp.

void vtkTexturedButtonRepresentation2D::CreateDefaultProperties ( )
protected

Member Data Documentation

vtkBalloonRepresentation* vtkTexturedButtonRepresentation2D::Balloon
protected

Definition at line 165 of file vtkTexturedButtonRepresentation2D.h.

vtkProperty2D* vtkTexturedButtonRepresentation2D::Property
protected

Definition at line 168 of file vtkTexturedButtonRepresentation2D.h.

vtkProperty2D* vtkTexturedButtonRepresentation2D::HoveringProperty
protected

Definition at line 169 of file vtkTexturedButtonRepresentation2D.h.

vtkProperty2D* vtkTexturedButtonRepresentation2D::SelectingProperty
protected

Definition at line 170 of file vtkTexturedButtonRepresentation2D.h.

vtkTextureArray* vtkTexturedButtonRepresentation2D::TextureArray
protected

Definition at line 175 of file vtkTexturedButtonRepresentation2D.h.

vtkCoordinate* vtkTexturedButtonRepresentation2D::Anchor
protected

Definition at line 178 of file vtkTexturedButtonRepresentation2D.h.


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