represent a vtkRectilinearWipeWidget More...

#include <vtkRectilinearWipeRepresentation.h>

Inheritance diagram for vtkRectilinearWipeRepresentation:

Collaboration diagram for vtkRectilinearWipeRepresentation:

Public Types
enum	_InteractionState { Outside =0, MovingHPane, MovingVPane, MovingCenter }

Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions

void	SetRectilinearWipe (vtkImageRectilinearWipe *wipe)

virtual vtkImageRectilinearWipe *	GetRectilinearWipe ()


void	SetImageActor (vtkImageActor *imageActor)

virtual vtkImageActor *	GetImageActor ()


virtual void	SetTolerance (int)

virtual int	GetTolerance ()


virtual vtkProperty2D *	GetProperty ()


virtual void	BuildRepresentation ()

virtual void	StartWidgetInteraction (double eventPos[2])

virtual void	WidgetInteraction (double eventPos[2])

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


virtual void	GetActors2D (vtkPropCollection *)

virtual void	ReleaseGraphicsResources (vtkWindow *)

virtual int	RenderOverlay (vtkViewport *viewport)

virtual int	RenderOpaqueGeometry (vtkViewport *viewport)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)

virtual int	HasTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkWidgetRepresentation
virtual void	SetRenderer (vtkRenderer *ren)

virtual vtkRenderer *	GetRenderer ()

virtual void	PlaceWidget (double *vtkNotUsed(bounds[6]))

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

virtual void	ShallowCopy (vtkProp *prop)

virtual void	GetActors (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))

void	PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions inherited from vtkProp
virtual void	Pick ()

virtual unsigned long	GetRedrawMTime ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

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

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

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 int	RenderVolumetricGeometry (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 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
virtual void	DebugOn ()

virtual void	DebugOff ()

unsigned char	GetDebug ()

void	SetDebug (unsigned char 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)

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	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &os)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkRectilinearWipeRepresentation *	New ()

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

static vtkWidgetRepresentation *	SafeDownCast (vtkObject *o)

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

static vtkProp *	SafeDownCast (vtkObject *o)

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

static vtkObject *	SafeDownCast (vtkObject *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
	vtkRectilinearWipeRepresentation ()

	~vtkRectilinearWipeRepresentation ()

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation ()

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

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 &os)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkImageRectilinearWipe *	RectilinearWipe

vtkImageActor *	ImageActor

int	Tolerance

double	StartWipePosition [2]

int	ActiveParts

vtkPoints *	Points

vtkCellArray *	Lines

vtkPolyData *	Wipe

vtkPolyDataMapper2D *	WipeMapper

vtkActor2D *	WipeActor

vtkProperty2D *	Property

double	DP4 [3]

double	DP5 [3]

double	DP6 [3]

double	DP7 [3]

double	DP8 [3]

int	Dims [3]

int	I

int	J

Protected Attributes inherited from vtkWidgetRepresentation
vtkRenderer *	Renderer

int	InteractionState

double	StartEventPosition [3]

double	PlaceFactor

int	Placed

double	InitialBounds [6]

double	InitialLength

int	ValidPick

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
unsigned char	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
int	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkWidgetRepresentation	Superclass

static int	IsTypeOf (const char *type)

static vtkRectilinearWipeRepresentation *	SafeDownCast (vtkObject *o)

virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent)

Detailed Description

represent a vtkRectilinearWipeWidget

This class is used to represent and render a vtkRectilinearWipeWidget. To use this class, you need to specify an instance of a vtkImageRectilinearWipe and vtkImageActor. This provides the information for this representation to construct and place itself.

The class may be subclassed so that alternative representations can be created. The class defines an API and a default implementation that the vtkRectilinearWipeWidget interacts with to render itself in the scene.

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

See also: vtkRectilinearWipeWidget vtkWidgetRepresentation vtkAbstractWidget

Tests:: vtkRectilinearWipeRepresentation (Tests)

Definition at line 56 of file vtkRectilinearWipeRepresentation.h.

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkRectilinearWipeRepresentation::Superclass

Standard methods for instances of this class.

Definition at line 64 of file vtkRectilinearWipeRepresentation.h.

Member Enumeration Documentation

enum vtkRectilinearWipeRepresentation::_InteractionState

Enumerator
Outside
MovingHPane
MovingVPane
MovingCenter

Definition at line 108 of file vtkRectilinearWipeRepresentation.h.

Constructor & Destructor Documentation

vtkRectilinearWipeRepresentation::vtkRectilinearWipeRepresentation ( )

protected

vtkRectilinearWipeRepresentation::~vtkRectilinearWipeRepresentation ( )

protected

Member Function Documentation

static vtkRectilinearWipeRepresentation* vtkRectilinearWipeRepresentation::New ( )

static

Instantiate this class.

virtual const char* vtkRectilinearWipeRepresentation::GetClassName ( )

virtual

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

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

static

Standard methods for instances of this class.

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

static vtkRectilinearWipeRepresentation* vtkRectilinearWipeRepresentation::SafeDownCast ( vtkObject * o )

static

Standard methods for instances of this class.

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkProp.

void vtkRectilinearWipeRepresentation::SetRectilinearWipe ( vtkImageRectilinearWipe * wipe )

Specify an instance of vtkImageRectilinearWipe to manipulate.

virtual vtkImageRectilinearWipe* vtkRectilinearWipeRepresentation::GetRectilinearWipe ( )

virtual

Specify an instance of vtkImageRectilinearWipe to manipulate.

void vtkRectilinearWipeRepresentation::SetImageActor ( vtkImageActor * imageActor )

Specify an instance of vtkImageActor to decorate.

virtual vtkImageActor* vtkRectilinearWipeRepresentation::GetImageActor ( )

virtual

Specify an instance of vtkImageActor to decorate.

virtual void vtkRectilinearWipeRepresentation::SetTolerance ( int )

virtual

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).

virtual int vtkRectilinearWipeRepresentation::GetTolerance ( )

virtual

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).

virtual vtkProperty2D* vtkRectilinearWipeRepresentation::GetProperty ( )

virtual

Get the properties for the widget. This can be manipulated to set different colors, line widths, etc.

virtual void vtkRectilinearWipeRepresentation::BuildRepresentation ( )

virtual

Subclasses of vtkRectilinearWipeRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Implements vtkWidgetRepresentation.

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

virtual

Subclasses of vtkRectilinearWipeRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkRectilinearWipeRepresentation::WidgetInteraction ( double eventPos[2] )

virtual

Subclasses of vtkRectilinearWipeRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

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

virtual

Subclasses of vtkRectilinearWipeRepresentation must implement these methods. These are the methods that the widget and its representation use to communicate with each other.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkRectilinearWipeRepresentation::GetActors2D ( vtkPropCollection * )

virtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkRectilinearWipeRepresentation::ReleaseGraphicsResources ( vtkWindow * )

virtual

Methods to make this class behave as a vtkProp.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkRectilinearWipeRepresentation::RenderOverlay ( vtkViewport * viewport )

virtual

Methods to make this class behave as a vtkProp.