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

#include <vtkLineRepresentation.h>

Inheritance diagram for vtkLineRepresentation:

Collaboration diagram for vtkLineRepresentation:

Public Types
enum	{ Outside =0, OnP1, OnP2, TranslatingP1, TranslatingP2, OnLine, 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)

virtual unsigned long	GetMTime ()

virtual void	SetRenderer (vtkRenderer *ren)

double	GetDistance ()

void	SetLineColor (double r, double g, double b)

virtual vtkProperty *	GetDistanceAnnotationProperty ()


void	GetPoint1WorldPosition (double pos[3])

double *	GetPoint1WorldPosition ()

void	GetPoint1DisplayPosition (double pos[3])

double *	GetPoint1DisplayPosition ()

void	SetPoint1WorldPosition (double pos[3])

void	SetPoint1DisplayPosition (double pos[3])

void	GetPoint2DisplayPosition (double pos[3])

double *	GetPoint2DisplayPosition ()

void	GetPoint2WorldPosition (double pos[3])

double *	GetPoint2WorldPosition ()

void	SetPoint2WorldPosition (double pos[3])

void	SetPoint2DisplayPosition (double pos[3])


void	SetHandleRepresentation (vtkPointHandleRepresentation3D *handle)

void	InstantiateHandleRepresentation ()


virtual vtkPointHandleRepresentation3D *	GetPoint1Representation ()

virtual vtkPointHandleRepresentation3D *	GetPoint2Representation ()

virtual vtkPointHandleRepresentation3D *	GetLineHandleRepresentation ()


virtual vtkProperty *	GetEndPointProperty ()

virtual vtkProperty *	GetSelectedEndPointProperty ()


virtual vtkProperty *	GetEndPoint2Property ()

virtual vtkProperty *	GetSelectedEndPoint2Property ()


virtual vtkProperty *	GetLineProperty ()

virtual vtkProperty *	GetSelectedLineProperty ()


virtual void	SetTolerance (int)

virtual int	GetTolerance ()


void	SetResolution (int res)

int	GetResolution ()


virtual void	PlaceWidget (double bounds[6])

virtual void	BuildRepresentation ()

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

virtual void	StartWidgetInteraction (double e[2])

virtual void	WidgetInteraction (double e[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 ()


virtual void	SetDistanceAnnotationVisibility (int)

virtual int	GetDistanceAnnotationVisibility ()

virtual void	DistanceAnnotationVisibilityOn ()

virtual void	DistanceAnnotationVisibilityOff ()


virtual void	SetDistanceAnnotationFormat (const char *)

virtual char *	GetDistanceAnnotationFormat ()


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

virtual void	SetDistanceAnnotationScale (double scale[3])

virtual double *	GetDistanceAnnotationScale ()


virtual vtkFollower *	GetTextActor ()

Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PickingManagedOn ()

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

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

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

	~vtkLineRepresentation ()

void	CreateDefaultProperties ()

void	ClampPosition (double x[3])

void	HighlightPoint (int ptId, int highlight)

void	HighlightLine (int highlight)

int	InBounds (double x[3])

void	SizeHandles ()

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation ()

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

virtual void	RegisterPickers ()

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
vtkPointHandleRepresentation3D *	HandleRepresentation

vtkPointHandleRepresentation3D *	Point1Representation

vtkPointHandleRepresentation3D *	Point2Representation

vtkPointHandleRepresentation3D *	LineHandleRepresentation

int	RepresentationState

vtkActor *	LineActor

vtkPolyDataMapper *	LineMapper

vtkLineSource *	LineSource

vtkActor **	Handle

vtkPolyDataMapper **	HandleMapper

vtkSphereSource **	HandleGeometry

vtkProperty *	EndPointProperty

vtkProperty *	SelectedEndPointProperty

vtkProperty *	EndPoint2Property

vtkProperty *	SelectedEndPoint2Property

vtkProperty *	LineProperty

vtkProperty *	SelectedLineProperty

int	Tolerance

int	ClampToBounds

double	StartP1 [3]

double	StartP2 [3]

double	StartLineHandle [3]

double	Length

double	LastEventPosition [3]

vtkBox *	BoundingBox

int	InitializedDisplayPosition

int	DistanceAnnotationVisibility

char *	DistanceAnnotationFormat

vtkFollower *	TextActor

vtkPolyDataMapper *	TextMapper

vtkVectorText *	TextInput

double	Distance

bool	AnnotationTextScaleInitialized

vtkCellPicker *	LinePicker

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

virtual int	IsA (const char *type)

vtkLineRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

a class defining the representation for a vtkLineWidget2

This class is a concrete representation for the vtkLineWidget2. It represents a straight line with three handles: one at the beginning and ending of the line, and one used to translate the line. Through interaction with the widget, the line representation can be arbitrarily placed in the 3D space.

To use this representation, you normally specify the position of the two end points (either in world or display coordinates). The PlaceWidget() method is also used to initially position the representation.

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

See also: vtkLineWidget2 vtkLineWidget

Tests:: vtkLineRepresentation (Tests)

Definition at line 60 of file vtkLineRepresentation.h.

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkLineRepresentation::Superclass

Standard methods for the class.

Definition at line 68 of file vtkLineRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator
Outside
OnP1
OnP2
TranslatingP1
TranslatingP2
OnLine
Scaling

Definition at line 175 of file vtkLineRepresentation.h.

Constructor & Destructor Documentation

vtkLineRepresentation::vtkLineRepresentation ( )

protected

vtkLineRepresentation::~vtkLineRepresentation ( )

protected

Member Function Documentation

static vtkLineRepresentation* vtkLineRepresentation::New ( )

static

Instantiate the class.

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

static

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

static

Standard methods for the class.

virtual vtkObjectBase* vtkLineRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

vtkLineRepresentation* vtkLineRepresentation::NewInstance ( ) const

Standard methods for the class.

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

virtual

Standard methods for the class.

Reimplemented from vtkObject.

void vtkLineRepresentation::GetPoint1WorldPosition ( double pos[3] )