abstract class defines interface between the widget and widget representation classes More...

#include <vtkWidgetRepresentation.h>

Inheritance diagram for vtkWidgetRepresentation:

Collaboration diagram for vtkWidgetRepresentation:

Public Types
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkWidgetRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	PickingManagedOn ()

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual void	SetRenderer (vtkRenderer *ren)

virtual vtkRenderer *	GetRenderer ()

virtual void	BuildRepresentation ()=0

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	ComputeInteractionState (int X, int Y, int modify=0)

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 double *	GetBounds ()

virtual void	ShallowCopy (vtkProp *prop)

virtual void	GetActors (vtkPropCollection *)

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	ReleaseGraphicsResources (vtkWindow *)

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 int	HasTranslucentPolygonalGeometry ()

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

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	Pick ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual unsigned long	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual int	RenderOpaqueGeometry (vtkViewport *)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

int	GetReferenceCount ()

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

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

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

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

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation ()

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

virtual void	RegisterPickers ()

virtual void	UnRegisterPickers ()

virtual void	PickersModified ()

vtkPickingManager *	GetPickingManager ()

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)

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

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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
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

Detailed Description

abstract class defines interface between the widget and widget representation classes

This class is used to define the API for, and partially implement, a representation for different types of widgets. Note that the widget representation (i.e., subclasses of vtkWidgetRepresentation) are a type of vtkProp; meaning that they can be associated with a vtkRenderer end embedded in a scene like any other vtkActor. However, vtkWidgetRepresentation also defines an API that enables it to be paired with a subclass vtkAbstractWidget, meaning that it can be driven by a widget, serving to represent the widget as the widget responds to registered events.

The API defined here should be regarded as a guideline for implementing widgets and widget representations. Widget behavior is complex, as is the way the representation responds to the registered widget events, so the API may vary from widget to widget to reflect this complexity.

Warning: The separation of the widget event handling and representation enables users and developers to create new appearances for the widget. It also facilitates parallel processing, where the client application handles events, and remote representations of the widget are slaves to the client (and do not handle events).

Definition at line 53 of file vtkWidgetRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkProp vtkWidgetRepresentation::Superclass

Standard methods for instances of this class.

Definition at line 58 of file vtkWidgetRepresentation.h.

Constructor & Destructor Documentation

◆ vtkWidgetRepresentation()

vtkWidgetRepresentation::vtkWidgetRepresentation ( )

protected

◆ ~vtkWidgetRepresentation()

vtkWidgetRepresentation::~vtkWidgetRepresentation ( )

protected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkWidgetRepresentation::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkProp.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWidgetRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProp.

◆ NewInstance()

vtkWidgetRepresentation* vtkWidgetRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkXYPlotRepresentation.

◆ PickingManagedOn()

virtual void vtkWidgetRepresentation::PickingManagedOn ( )

virtual

Enable/Disable the use of a manager to process the picking. Enabled by default.

◆ PickingManagedOff()

virtual void vtkWidgetRepresentation::PickingManagedOff ( )

virtual

◆ SetPickingManaged()

virtual void vtkWidgetRepresentation::SetPickingManaged ( bool )

virtual

◆ GetPickingManaged()

virtual bool vtkWidgetRepresentation::GetPickingManaged ( )

virtual

◆ SetRenderer()

virtual void vtkWidgetRepresentation::SetRenderer ( vtkRenderer * ren )

virtual

Subclasses of vtkWidgetRepresentation must implement these methods. This is considered the minimum API for a widget representation.

SetRenderer() - the renderer in which the widget is to appear must be
set. BuildRepresentation() - update the geometry of the widget based
on its current state.

WARNING: The renderer is NOT reference counted by the representation, in order to avoid reference loops. Be sure that the representation lifetime does not extend beyond the renderer lifetime.

Reimplemented in vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, vtkLineRepresentation, vtkHandleRepresentation, vtkConstrainedPointHandleRepresentation, and vtkCompassRepresentation.

◆ GetRenderer()

virtual vtkRenderer* vtkWidgetRepresentation::GetRenderer ( )

virtual

◆ BuildRepresentation()

virtual void vtkWidgetRepresentation::BuildRepresentation ( )

pure virtual

◆ PlaceWidget()

virtual void vtkWidgetRepresentation::PlaceWidget ( double * vtkNotUsedbounds[6] )

inlinevirtual

The following is a suggested API for widget representations. These methods define the communication between the widget and its representation. These methods are only suggestions because widgets take on so many different forms that a universal API is not deemed practical. However, these methods should be implemented when possible to insure that the VTK widget hierarchy remains self-consistent.

 PlaceWidget() - given a bounding box
(xmin,xmax,ymin,ymax,zmin,zmax), place the widget inside of it. The
current orientation of the widget is preserved, only scaling and
translation is performed. StartWidgetInteraction() - generally
corresponds to a initial event (e.g., mouse down) that starts the
interaction process with the widget. WidgetInteraction() - invoked
when an event causes the widget to change appearance.
EndWidgetInteraction() - generally corresponds to a final event
(e.g., mouse up) and completes the interaction sequence.
ComputeInteractionState() - given (X,Y) display coordinates in a
renderer, with a possible flag that modifies the computation, what is
the state of the widget? GetInteractionState() - return the current
state of the widget. Note that the value of "0" typically refers to
"outside". The interaction state is strictly a function of the
representation, and the widget/represent must agree on what they
mean. Highlight() - turn on or off any highlights associated with the
widget. Highlights are generally turned on when the widget is
selected.

Note that subclasses may ignore some of these methods and implement their own depending on the specifics of the widget.

Definition at line 111 of file vtkWidgetRepresentation.h.

◆ StartWidgetInteraction()

virtual void vtkWidgetRepresentation::StartWidgetInteraction ( double eventPos[2] )

inlinevirtual

Definition at line 112 of file vtkWidgetRepresentation.h.

◆ WidgetInteraction()

virtual void vtkWidgetRepresentation::WidgetInteraction ( double newEventPos[2] )

inlinevirtual

Reimplemented in vtkSliderRepresentation3D, vtkSliderRepresentation2D, vtkImplicitPlaneRepresentation, vtkContinuousValueWidgetRepresentation, vtkXYPlotRepresentation, vtkSphereHandleRepresentation, vtkScalarBarRepresentation, vtkRectilinearWipeRepresentation, vtkPointHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, vtkConstrainedPointHandleRepresentation, vtkCenteredSliderRepresentation, vtkBorderRepresentation, vtkAffineRepresentation2D, vtkAbstractPolygonalHandleRepresentation3D, vtkCompassRepresentation, vtkContourRepresentation, vtkSphereRepresentation, vtkResliceCursorLineRepresentation, vtkLineRepresentation, vtkDistanceRepresentation, vtkCurveRepresentation, vtkBoxRepresentation, vtkBiDimensionalRepresentation2D, vtkAxesTransformRepresentation, and vtkAngleRepresentation.

Definition at line 113 of file vtkWidgetRepresentation.h.

◆ EndWidgetInteraction()

virtual void vtkWidgetRepresentation::EndWidgetInteraction ( double newEventPos[2] )

inlinevirtual

Reimplemented in vtkImplicitPlaneRepresentation, vtkAffineRepresentation2D, vtkCurveRepresentation, and vtkBalloonRepresentation.

Definition at line 114 of file vtkWidgetRepresentation.h.

◆ ComputeInteractionState()

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

virtual

Reimplemented in vtkTexturedButtonRepresentation2D, vtkTexturedButtonRepresentation, vtkSphereRepresentation, vtkSphereHandleRepresentation, vtkSeedRepresentation, vtkResliceCursorLineRepresentation, vtkRectilinearWipeRepresentation, vtkProp3DButtonRepresentation, vtkPointHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkParallelopipedRepresentation, vtkLineRepresentation, vtkImplicitPlaneRepresentation, vtkDistanceRepresentation, vtkCurveRepresentation, vtkCenteredSliderRepresentation, vtkBoxRepresentation, vtkBorderRepresentation, vtkBiDimensionalRepresentation2D, vtkBalloonRepresentation, vtkAxesTransformRepresentation, vtkAngleRepresentation, vtkAffineRepresentation2D, vtkAbstractPolygonalHandleRepresentation3D, vtkCompassRepresentation, vtkConstrainedPointHandleRepresentation, vtkContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, and vtkOrientedGlyphContourRepresentation.

◆ GetInteractionState()

virtual int vtkWidgetRepresentation::GetInteractionState ( )

inlinevirtual

Definition at line 116 of file vtkWidgetRepresentation.h.

◆ Highlight()

virtual void vtkWidgetRepresentation::Highlight ( int vtkNotUsedhighlightOn )

inlinevirtual

Definition at line 118 of file vtkWidgetRepresentation.h.

◆ SetPlaceFactor()

virtual void vtkWidgetRepresentation::SetPlaceFactor ( double )

virtual

Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.

◆ GetPlaceFactor()

virtual double vtkWidgetRepresentation::GetPlaceFactor ( )

virtual

◆ SetHandleSize()

virtual void vtkWidgetRepresentation::SetHandleSize ( double )

virtual

Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). These handles (like spheres, etc.) are used to manipulate the widget. The HandleSize data member allows you to change the relative size of the handles. Note that while the handle size is typically expressed in pixels, some subclasses may use a relative size with respect to the viewport. (As a corollary, the value of this ivar is often set by subclasses of this class during instance instantiation.)

Reimplemented in vtkSphereHandleRepresentation, and vtkPointHandleRepresentation3D.

◆ GetHandleSize()

virtual double vtkWidgetRepresentation::GetHandleSize ( )

virtual

◆ GetNeedToRender()

virtual int vtkWidgetRepresentation::GetNeedToRender ( )

virtual

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

◆ SetNeedToRender()

virtual void vtkWidgetRepresentation::SetNeedToRender ( int )

virtual

◆ NeedToRenderOn()

virtual void vtkWidgetRepresentation::NeedToRenderOn ( )

virtual

◆ NeedToRenderOff()

virtual void vtkWidgetRepresentation::NeedToRenderOff ( )

virtual

◆ GetBounds()

virtual double* vtkWidgetRepresentation::GetBounds ( void )

inlinevirtual

Methods to make this class behave as a vtkProp. They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).

Reimplemented from vtkProp.

Reimplemented in vtkTexturedButtonRepresentation2D, vtkTexturedButtonRepresentation, vtkSphereRepresentation, vtkSphereHandleRepresentation, vtkSliderRepresentation3D, vtkResliceCursorLineRepresentation, vtkProp3DButtonRepresentation, vtkPointHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkParallelopipedRepresentation, vtkOrientedGlyphContourRepresentation, vtkLineRepresentation, vtkImplicitPlaneRepresentation, vtkDistanceRepresentation3D, vtkCurveRepresentation, vtkBoxRepresentation, vtkAxesTransformRepresentation, and vtkAbstractPolygonalHandleRepresentation3D.

Definition at line 161 of file vtkWidgetRepresentation.h.

◆ ShallowCopy()

virtual void vtkWidgetRepresentation::ShallowCopy ( vtkProp * prop )

virtual

Shallow copy of this vtkProp.

Reimplemented from vtkProp.

Reimplemented in vtkTexturedButtonRepresentation2D, vtkTexturedButtonRepresentation, vtkSphereHandleRepresentation, vtkProp3DButtonRepresentation, vtkPointHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkHandleRepresentation, vtkConstrainedPointHandleRepresentation, vtkButtonRepresentation, vtkAffineRepresentation2D, vtkAffineRepresentation, and vtkAbstractPolygonalHandleRepresentation3D.

◆ GetActors()

virtual void vtkWidgetRepresentation::GetActors ( vtkPropCollection * )

inlinevirtual

For some exporters and other other operations we must be able to collect all the actors or volumes. These methods are used in that process.

Reimplemented from vtkProp.

Reimplemented in vtkTexturedButtonRepresentation2D, vtkTexturedButtonRepresentation, vtkProp3DButtonRepresentation, vtkParallelopipedRepresentation, vtkLineRepresentation, vtkImplicitPlaneRepresentation, vtkTensorProbeRepresentation, vtkSphereHandleRepresentation, vtkSliderRepresentation3D, vtkPointHandleRepresentation3D, vtkOrientedGlyphContourRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkConstrainedPointHandleRepresentation, vtkCheckerboardRepresentation, vtkCenteredSliderRepresentation, vtkAbstractPolygonalHandleRepresentation3D, and vtkCompassRepresentation.

Definition at line 163 of file vtkWidgetRepresentation.h.

◆ GetActors2D()

virtual void vtkWidgetRepresentation::GetActors2D ( vtkPropCollection * )

inlinevirtual

Reimplemented from vtkProp.

Reimplemented in vtkLogoRepresentation, vtkXYPlotRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, vtkSliderRepresentation2D, vtkRectilinearWipeRepresentation, vtkPointHandleRepresentation2D, vtkPlaybackRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkCaptionRepresentation, vtkCameraRepresentation, vtkBorderRepresentation, and vtkAffineRepresentation2D.

Definition at line 164 of file vtkWidgetRepresentation.h.

◆ GetVolumes()

virtual void vtkWidgetRepresentation::GetVolumes ( vtkPropCollection * )

inlinevirtual

Reimplemented from vtkProp.

Definition at line 165 of file vtkWidgetRepresentation.h.

◆ ReleaseGraphicsResources()

virtual void vtkWidgetRepresentation::ReleaseGraphicsResources ( vtkWindow * )

inlinevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

Reimplemented in vtkXYPlotRepresentation, vtkScalarBarRepresentation, vtkContourRepresentation, vtkResliceCursorLineRepresentation, vtkParallelopipedRepresentation, vtkDistanceRepresentation3D, vtkDistanceRepresentation2D, vtkCheckerboardRepresentation, vtkBiDimensionalRepresentation2D, vtkBalloonRepresentation, vtkAxesTransformRepresentation, vtkAngleRepresentation3D, vtkAngleRepresentation2D, vtkTexturedButtonRepresentation2D, vtkTexturedButtonRepresentation, vtkTextRepresentation, vtkTensorProbeRepresentation, vtkSphereRepresentation, vtkSphereHandleRepresentation, vtkSliderRepresentation3D, vtkSliderRepresentation2D, vtkRectilinearWipeRepresentation, vtkProp3DButtonRepresentation, vtkPointHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkPlaybackRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, vtkLogoRepresentation, vtkLineRepresentation, vtkImplicitPlaneRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkCurveRepresentation, vtkConstrainedPointHandleRepresentation, vtkCenteredSliderRepresentation, vtkCaptionRepresentation, vtkCameraRepresentation, vtkBoxRepresentation, vtkBorderRepresentation, vtkAffineRepresentation2D, vtkAbstractPolygonalHandleRepresentation3D, and vtkCompassRepresentation.

Definition at line 166 of file vtkWidgetRepresentation.h.

◆ RenderOverlay()

virtual int vtkWidgetRepresentation::RenderOverlay ( vtkViewport * vtkNotUsedviewport )

inlinevirtual

Definition at line 167 of file vtkWidgetRepresentation.h.

◆ RenderOpaqueGeometry()

virtual int vtkWidgetRepresentation::RenderOpaqueGeometry ( vtkViewport * vtkNotUsedviewport )

inlinevirtual

Definition at line 168 of file vtkWidgetRepresentation.h.

◆ RenderTranslucentPolygonalGeometry()

virtual int vtkWidgetRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport * vtkNotUsedviewport )

inlinevirtual

Definition at line 169 of file vtkWidgetRepresentation.h.

◆ RenderVolumetricGeometry()

virtual int vtkWidgetRepresentation::RenderVolumetricGeometry ( vtkViewport * vtkNotUsedviewport )

inlinevirtual

Definition at line 170 of file vtkWidgetRepresentation.h.

◆ HasTranslucentPolygonalGeometry()

virtual int vtkWidgetRepresentation::HasTranslucentPolygonalGeometry ( )

inlinevirtual

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. A simple prop that has some translucent polygonal geometry will return true. A composite prop (like vtkAssembly) that has at least one sub-prop that has some translucent polygonal geometry will return true. Default implementation return false.

Reimplemented from vtkProp.

Reimplemented in vtkContourRepresentation, vtkXYPlotRepresentation, vtkTexturedButtonRepresentation2D, vtkTexturedButtonRepresentation, vtkTextRepresentation, vtkSphereRepresentation, vtkSphereHandleRepresentation, vtkSliderRepresentation3D, vtkScalarBarRepresentation, vtkResliceCursorLineRepresentation, vtkRectilinearWipeRepresentation, vtkProp3DButtonRepresentation, vtkPointHandleRepresentation3D, vtkPlaybackRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, vtkLineRepresentation, vtkImplicitPlaneRepresentation, vtkCurveRepresentation, vtkConstrainedPointHandleRepresentation, vtkCheckerboardRepresentation, vtkCaptionRepresentation, vtkCameraRepresentation, vtkBoxRepresentation, vtkBorderRepresentation, vtkAngleRepresentation3D, and vtkAbstractPolygonalHandleRepresentation3D.

Definition at line 171 of file vtkWidgetRepresentation.h.

◆ AdjustBounds()

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

protected

◆ RegisterPickers()

virtual void vtkWidgetRepresentation::RegisterPickers ( )

protectedvirtual

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

Reimplemented in vtkTexturedButtonRepresentation, vtkSphereRepresentation, vtkSphereHandleRepresentation, vtkSliderRepresentation3D, vtkProp3DButtonRepresentation, vtkPointHandleRepresentation3D, vtkImplicitPlaneRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkCurveRepresentation, vtkBoxRepresentation, and vtkAbstractPolygonalHandleRepresentation3D.

◆ UnRegisterPickers()

virtual void vtkWidgetRepresentation::UnRegisterPickers ( )

protectedvirtual

Unregister internal pickers from the Picking Manager.

◆ PickersModified()

virtual void vtkWidgetRepresentation::PickersModified ( )

protectedvirtual

Update the pickers registered in the Picking Manager when pickers are modified.

◆ GetPickingManager()

vtkPickingManager* vtkWidgetRepresentation::GetPickingManager ( )

protected

Return the picking manager associated on the context on which the widget representation currently belong.

◆ GetAssemblyPath()

vtkAssemblyPath* vtkWidgetRepresentation::GetAssemblyPath	(	double	X,
		double	Y,
		double	Z,
		vtkAbstractPropPicker *	picker
	)

protected

Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path.

◆ SizeHandlesRelativeToViewport()

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

protected

◆ SizeHandlesInPixels()

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

protected

Member Data Documentation

◆ Renderer

vtkWeakPointer<vtkRenderer> vtkWidgetRepresentation::Renderer

protected

Definition at line 179 of file vtkWidgetRepresentation.h.

◆ InteractionState

int vtkWidgetRepresentation::InteractionState

protected

Definition at line 182 of file vtkWidgetRepresentation.h.

◆ StartEventPosition

double vtkWidgetRepresentation::StartEventPosition[3]

protected

Definition at line 186 of file vtkWidgetRepresentation.h.

◆ PlaceFactor

double vtkWidgetRepresentation::PlaceFactor

protected

Definition at line 189 of file vtkWidgetRepresentation.h.

◆ Placed

int vtkWidgetRepresentation::Placed

protected

Definition at line 190 of file vtkWidgetRepresentation.h.

◆ InitialBounds

double vtkWidgetRepresentation::InitialBounds[6]

protected

Definition at line 192 of file vtkWidgetRepresentation.h.

◆ InitialLength

double vtkWidgetRepresentation::InitialLength

protected

Definition at line 193 of file vtkWidgetRepresentation.h.

◆ ValidPick

int vtkWidgetRepresentation::ValidPick

protected

Definition at line 200 of file vtkWidgetRepresentation.h.

◆ PickingManaged

bool vtkWidgetRepresentation::PickingManaged

protected

Definition at line 204 of file vtkWidgetRepresentation.h.

◆ HandleSize

double vtkWidgetRepresentation::HandleSize

protected

Definition at line 234 of file vtkWidgetRepresentation.h.

◆ NeedToRender

int vtkWidgetRepresentation::NeedToRender

protected

Definition at line 239 of file vtkWidgetRepresentation.h.

◆ BuildTime

vtkTimeStamp vtkWidgetRepresentation::BuildTime

protected

Definition at line 243 of file vtkWidgetRepresentation.h.

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

dox/opt/build/vtk6-6.3.0+dfsg2/Interaction/Widgets/vtkWidgetRepresentation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkWidgetRepresentation()

◆ ~vtkWidgetRepresentation()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ PickingManagedOn()

◆ PickingManagedOff()

◆ SetPickingManaged()

◆ GetPickingManaged()

◆ SetRenderer()

◆ GetRenderer()

◆ BuildRepresentation()

◆ PlaceWidget()

◆ StartWidgetInteraction()

◆ WidgetInteraction()

◆ EndWidgetInteraction()

◆ ComputeInteractionState()

◆ GetInteractionState()

◆ Highlight()

◆ SetPlaceFactor()

◆ GetPlaceFactor()

◆ SetHandleSize()

◆ GetHandleSize()

◆ GetNeedToRender()

◆ SetNeedToRender()

◆ NeedToRenderOn()

◆ NeedToRenderOff()

◆ GetBounds()

◆ ShallowCopy()

◆ GetActors()

◆ GetActors2D()

◆ GetVolumes()

◆ ReleaseGraphicsResources()

◆ RenderOverlay()

◆ RenderOpaqueGeometry()

◆ RenderTranslucentPolygonalGeometry()

◆ RenderVolumetricGeometry()

◆ HasTranslucentPolygonalGeometry()

◆ AdjustBounds()

◆ RegisterPickers()

◆ UnRegisterPickers()

◆ PickersModified()

◆ GetPickingManager()

◆ GetAssemblyPath()

◆ SizeHandlesRelativeToViewport()

◆ SizeHandlesInPixels()

Member Data Documentation

◆ Renderer

◆ InteractionState

◆ StartEventPosition

◆ PlaceFactor

◆ Placed

◆ InitialBounds

◆ InitialLength

◆ ValidPick

◆ PickingManaged

◆ HandleSize

◆ NeedToRender

◆ BuildTime