a class defining the representation for a vtkImplicitPlaneWidget2 More...

#include <vtkImplicitPlaneRepresentation.h>

Inheritance diagram for vtkImplicitPlaneRepresentation:

Collaboration diagram for vtkImplicitPlaneRepresentation:

Public Types
enum	_InteractionState { Outside =0, Moving, MovingOutline, MovingOrigin, Rotating, Pushing, Scaling }

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	GetPolyData (vtkPolyData *pd)

vtkPolyDataAlgorithm *	GetPolyDataAlgorithm ()

void	GetPlane (vtkPlane *plane)

void	UpdatePlacement (void)

void	BumpPlane (int dir, double factor)

void	PushPlane (double distance)


void	SetOrigin (double x, double y, double z)

void	SetOrigin (double x[3])

double *	GetOrigin ()

void	GetOrigin (double xyz[3])


void	SetNormal (double x, double y, double z)

void	SetNormal (double x[3])

void	SetNormalToCamera ()

double *	GetNormal ()

void	GetNormal (double xyz[3])


void	SetNormalToXAxis (int)

virtual int	GetNormalToXAxis ()

virtual void	NormalToXAxisOn ()

virtual void	NormalToXAxisOff ()

void	SetNormalToYAxis (int)

virtual int	GetNormalToYAxis ()

virtual void	NormalToYAxisOn ()

virtual void	NormalToYAxisOff ()

void	SetNormalToZAxis (int)

virtual int	GetNormalToZAxis ()

virtual void	NormalToZAxisOn ()

virtual void	NormalToZAxisOff ()


virtual void	SetLockNormalToCamera (int)

virtual int	GetLockNormalToCamera ()

virtual void	LockNormalToCameraOn ()

virtual void	LockNormalToCameraOff ()


virtual void	SetTubing (int)

virtual int	GetTubing ()

virtual void	TubingOn ()

virtual void	TubingOff ()


void	SetDrawPlane (int plane)

virtual int	GetDrawPlane ()

virtual void	DrawPlaneOn ()

virtual void	DrawPlaneOff ()


virtual void	SetOutlineTranslation (int)

virtual int	GetOutlineTranslation ()

virtual void	OutlineTranslationOn ()

virtual void	OutlineTranslationOff ()


virtual void	SetOutsideBounds (int)

virtual int	GetOutsideBounds ()

virtual void	OutsideBoundsOn ()

virtual void	OutsideBoundsOff ()


virtual void	SetScaleEnabled (int)

virtual int	GetScaleEnabled ()

virtual void	ScaleEnabledOn ()

virtual void	ScaleEnabledOff ()


virtual vtkProperty *	GetNormalProperty ()

virtual vtkProperty *	GetSelectedNormalProperty ()


virtual vtkProperty *	GetPlaneProperty ()

virtual vtkProperty *	GetSelectedPlaneProperty ()


virtual vtkProperty *	GetOutlineProperty ()

virtual vtkProperty *	GetSelectedOutlineProperty ()


virtual vtkProperty *	GetEdgesProperty ()


void	SetEdgeColor (vtkLookupTable *)

void	SetEdgeColor (double, double, double)

void	SetEdgeColor (double x[3])


virtual void	SetBumpDistance (double)

virtual double	GetBumpDistance ()


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

virtual void	PlaceWidget (double bounds[6])

virtual void	BuildRepresentation ()

virtual void	StartWidgetInteraction (double eventPos[2])

virtual void	WidgetInteraction (double newEventPos[2])

virtual void	EndWidgetInteraction (double newEventPos[2])


virtual double *	GetBounds ()

virtual void	GetActors (vtkPropCollection *pc)

virtual void	ReleaseGraphicsResources (vtkWindow *)

virtual int	RenderOpaqueGeometry (vtkViewport *)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	HasTranslucentPolygonalGeometry ()


virtual void	SetInteractionState (int)


virtual void	SetRepresentationState (int)

virtual int	GetRepresentationState ()

Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PickingManagedOn ()

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual void	SetRenderer (vtkRenderer *ren)

virtual vtkRenderer *	GetRenderer ()

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

virtual int	GetInteractionState ()

virtual void	Highlight (int vtkNotUsed(highlightOn))

virtual void	SetPlaceFactor (double)

virtual double	GetPlaceFactor ()

virtual void	SetHandleSize (double)

virtual double	GetHandleSize ()

virtual int	GetNeedToRender ()

virtual void	SetNeedToRender (int)

virtual void	NeedToRenderOn ()

virtual void	NeedToRenderOff ()

virtual void	ShallowCopy (vtkProp *prop)

virtual void	GetActors2D (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual int	RenderOverlay (vtkViewport *vtkNotUsed(viewport))

virtual int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))

virtual int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))

vtkWidgetRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

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

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Pick ()

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

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkImplicitPlaneRepresentation *	New ()

Static Public Member Functions inherited from vtkWidgetRepresentation
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
	vtkImplicitPlaneRepresentation ()

	~vtkImplicitPlaneRepresentation ()

void	HighlightOutline (int highlight)

void	HighlightPlane (int highlight)

void	HighlightNormal (int highlight)

virtual void	RegisterPickers ()

void	ConstrainOrigin (double x[3])

void	Rotate (double X, double Y, double p1, double p2, double *vpn)

void	TranslatePlane (double p1, double p2)

void	TranslateOutline (double p1, double p2)

void	TranslateOrigin (double p1, double p2)

void	Push (double p1, double p2)

void	Scale (double p1, double p2, double X, double Y)

void	SizeHandles ()

void	CreateDefaultProperties ()

void	GeneratePlane ()

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation ()

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

virtual void	UnRegisterPickers ()

virtual void	PickersModified ()

vtkPickingManager *	GetPickingManager ()

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

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

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

Protected 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
int	RepresentationState

double	LastEventPosition [3]

int	NormalToXAxis

int	NormalToYAxis

int	NormalToZAxis

int	LockNormalToCamera

double	BumpDistance

vtkPlane *	Plane

vtkImageData *	Box

vtkOutlineFilter *	Outline

vtkPolyDataMapper *	OutlineMapper

vtkActor *	OutlineActor

int	OutlineTranslation

int	ScaleEnabled

int	OutsideBounds

vtkCutter *	Cutter

vtkPolyDataMapper *	CutMapper

vtkActor *	CutActor

int	DrawPlane

vtkFeatureEdges *	Edges

vtkTubeFilter *	EdgesTuber

vtkPolyDataMapper *	EdgesMapper

vtkActor *	EdgesActor

int	Tubing

vtkConeSource *	ConeSource

vtkPolyDataMapper *	ConeMapper

vtkActor *	ConeActor

vtkLineSource *	LineSource

vtkPolyDataMapper *	LineMapper

vtkActor *	LineActor

vtkConeSource *	ConeSource2

vtkPolyDataMapper *	ConeMapper2

vtkActor *	ConeActor2

vtkLineSource *	LineSource2

vtkPolyDataMapper *	LineMapper2

vtkActor *	LineActor2

vtkSphereSource *	Sphere

vtkPolyDataMapper *	SphereMapper

vtkActor *	SphereActor

vtkCellPicker *	Picker

vtkTransform *	Transform

vtkProperty *	NormalProperty

vtkProperty *	SelectedNormalProperty

vtkProperty *	PlaneProperty

vtkProperty *	SelectedPlaneProperty

vtkProperty *	OutlineProperty

vtkProperty *	SelectedOutlineProperty

vtkProperty *	EdgesProperty

vtkBox *	BoundingBox

Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRenderer >	Renderer

int	InteractionState

double	StartEventPosition [3]

double	PlaceFactor

int	Placed

double	InitialBounds [6]

double	InitialLength

int	ValidPick

bool	PickingManaged

double	HandleSize

int	NeedToRender

vtkTimeStamp	BuildTime

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

typedef vtkWidgetRepresentation	Superclass

static int	IsTypeOf (const char *type)

static vtkImplicitPlaneRepresentation *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkImplicitPlaneRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

a class defining the representation for a vtkImplicitPlaneWidget2

This class is a concrete representation for the vtkImplicitPlaneWidget2. It represents an infinite plane defined by a normal and point in the context of a bounding box. Through interaction with the widget, the plane can be manipulated by adjusting the plane normal or moving the origin point.

To use this representation, you normally define a (plane) origin and (plane) normal. The PlaceWidget() method is also used to initially position the representation.

Warning: This class, and vtkImplicitPlaneWidget2, are next generation VTK widgets. An earlier version of this functionality was defined in the class vtkImplicitPlaneWidget.

See also: vtkImplicitPlaneWidget2 vtkImplicitPlaneWidget

Tests:: vtkImplicitPlaneRepresentation (Tests)

Definition at line 65 of file vtkImplicitPlaneRepresentation.h.

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkImplicitPlaneRepresentation::Superclass

Standard methods for the class.

Definition at line 73 of file vtkImplicitPlaneRepresentation.h.

Member Enumeration Documentation

enum vtkImplicitPlaneRepresentation::_InteractionState

Enumerator
Outside
Moving
MovingOutline
MovingOrigin
Rotating
Pushing
Scaling

Definition at line 251 of file vtkImplicitPlaneRepresentation.h.

Constructor & Destructor Documentation

vtkImplicitPlaneRepresentation::vtkImplicitPlaneRepresentation ( )

protected

vtkImplicitPlaneRepresentation::~vtkImplicitPlaneRepresentation ( )

protected

Member Function Documentation

static vtkImplicitPlaneRepresentation* vtkImplicitPlaneRepresentation::New ( )

static

Instantiate the class.

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

static

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

static

Standard methods for the class.

virtual vtkObjectBase* vtkImplicitPlaneRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

vtkImplicitPlaneRepresentation* vtkImplicitPlaneRepresentation::NewInstance ( ) const

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkObject.

void vtkImplicitPlaneRepresentation::SetOrigin	(	double	x,
		double	y,
		double	z
	)

Get the origin of the plane.

void vtkImplicitPlaneRepresentation::SetOrigin ( double x[3] )

Get the origin of the plane.

double* vtkImplicitPlaneRepresentation::GetOrigin ( )

Get the origin of the plane.

void vtkImplicitPlaneRepresentation::GetOrigin ( double xyz[3] )

Get the origin of the plane.

void vtkImplicitPlaneRepresentation::SetNormal	(	double	x,
		double	y,
		double	z
	)

Get the normal to the plane.

void vtkImplicitPlaneRepresentation::SetNormal ( double x[3] )

Get the normal to the plane.

void vtkImplicitPlaneRepresentation::SetNormalToCamera ( )

Get the normal to the plane.

double* vtkImplicitPlaneRepresentation::GetNormal ( )

Get the normal to the plane.

void vtkImplicitPlaneRepresentation::GetNormal ( double xyz[3] )

Get the normal to the plane.

void vtkImplicitPlaneRepresentation::SetNormalToXAxis ( int )