representation for a spline. More...

#include <vtkSplineRepresentation.h>

Inheritance diagram for vtkSplineRepresentation:

Collaboration diagram for vtkSplineRepresentation:

Public Types
typedef vtkCurveRepresentation	Superclass

Public Types inherited from vtkCurveRepresentation
enum	_InteractionState { Outside =0, OnHandle, OnLine, Moving, Scaling, Spinning, Inserting, Erasing }

typedef vtkWidgetRepresentation	Superclass

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
virtual int	IsA (const char *type)

vtkSplineRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	GetPolyData (vtkPolyData *pd)

virtual void	SetNumberOfHandles (int npts)

vtkDoubleArray *	GetHandlePositions ()

double	GetSummedLength ()

void	InitializeHandles (vtkPoints *points)

virtual void	BuildRepresentation ()


void	SetResolution (int resolution)

virtual int	GetResolution ()


virtual void	SetParametricSpline (vtkParametricSpline *)

virtual vtkParametricSpline *	GetParametricSpline ()

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

void	SetPlaneSource (vtkPlaneSource *plane)

virtual void	SetProjectionNormal (int)

virtual int	GetProjectionNormal ()

void	SetProjectionNormalToXAxes ()

void	SetProjectionNormalToYAxes ()

void	SetProjectionNormalToZAxes ()

void	SetProjectionNormalToOblique ()

int	IsClosed ()

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

virtual void	SetInteractionState (int)

virtual void	SetProjectToPlane (int)

virtual int	GetProjectToPlane ()

virtual void	ProjectToPlaneOn ()

virtual void	ProjectToPlaneOff ()

void	SetProjectionPosition (double position)

virtual double	GetProjectionPosition ()

virtual vtkProperty *	GetHandleProperty ()

virtual vtkProperty *	GetSelectedHandleProperty ()

virtual vtkProperty *	GetLineProperty ()

virtual vtkProperty *	GetSelectedLineProperty ()

virtual int	GetNumberOfHandles ()

virtual void	SetHandlePosition (int handle, double x, double y, double z)

virtual void	SetHandlePosition (int handle, double xyz[3])

virtual void	GetHandlePosition (int handle, double xyz[3])

virtual double *	GetHandlePosition (int handle)

void	SetClosed (int closed)

virtual int	GetClosed ()

virtual void	ClosedOn ()

virtual void	ClosedOff ()

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

virtual void	StartWidgetInteraction (double e[2])

virtual void	WidgetInteraction (double e[2])

virtual void	EndWidgetInteraction (double e[2])

virtual double *	GetBounds ()

virtual void	ReleaseGraphicsResources (vtkWindow *)

virtual int	RenderOpaqueGeometry (vtkViewport *)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

virtual int	HasTranslucentPolygonalGeometry ()

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	GetActors (vtkPropCollection *)

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 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 vtkSplineRepresentation *	New ()

static int	IsTypeOf (const char *type)

static vtkSplineRepresentation *	SafeDownCast (vtkObjectBase *o)

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

static vtkCurveRepresentation *	SafeDownCast (vtkObjectBase *o)

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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSplineRepresentation ()

	~vtkSplineRepresentation ()

virtual void	InsertHandleOnLine (double *pos)

Protected Member Functions inherited from vtkCurveRepresentation
	vtkCurveRepresentation ()

	~vtkCurveRepresentation ()

void	ProjectPointsToPlane ()

void	ProjectPointsToOrthoPlane ()

void	ProjectPointsToObliquePlane ()

void	HighlightLine (int highlight)

void	Initialize ()

int	HighlightHandle (vtkProp *prop)

virtual void	SizeHandles ()

void	EraseHandle (const int &)

virtual void	RegisterPickers ()

void	MovePoint (double p1, double p2)

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

void	Translate (double p1, double p2)

void	Spin (double p1, double p2, double *vpn)

void	CreateDefaultProperties ()

void	CalculateCentroid ()

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
vtkParametricSpline *	ParametricSpline

vtkParametricFunctionSource *	ParametricFunctionSource

int	Resolution

Protected Attributes inherited from vtkCurveRepresentation
double	LastEventPosition [3]

double	Bounds [6]

int	ProjectionNormal

double	ProjectionPosition

int	ProjectToPlane

vtkPlaneSource *	PlaneSource

int	NumberOfHandles

int	Closed

vtkActor *	LineActor

vtkActor **	Handle

vtkSphereSource **	HandleGeometry

vtkCellPicker *	HandlePicker

vtkCellPicker *	LinePicker

double	LastPickPosition [3]

vtkActor *	CurrentHandle

int	CurrentHandleIndex

vtkTransform *	Transform

vtkProperty *	HandleProperty

vtkProperty *	SelectedHandleProperty

vtkProperty *	LineProperty

vtkProperty *	SelectedLineProperty

double	Centroid [3]

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

Detailed Description

representation for a spline.

vtkSplineRepresentation is a vtkWidgetRepresentation for a spline. This 3D widget defines a spline that can be interactively placed in a scene. The spline has handles, the number of which can be changed, plus it can be picked on the spline itself to translate or rotate it in the scene. This is based on vtkSplineWidget.

See also: vtkSplineWidget, vtkSplineWidget2

Tests:: vtkSplineRepresentation (Tests)

Definition at line 49 of file vtkSplineRepresentation.h.

Member Typedef Documentation

typedef vtkCurveRepresentation vtkSplineRepresentation::Superclass

Definition at line 53 of file vtkSplineRepresentation.h.

Constructor & Destructor Documentation

vtkSplineRepresentation::vtkSplineRepresentation ( )

protected

vtkSplineRepresentation::~vtkSplineRepresentation ( )

protected

Member Function Documentation

static vtkSplineRepresentation* vtkSplineRepresentation::New ( )

static

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

static

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

virtual

Standard methods for instances of this class.

Reimplemented from vtkCurveRepresentation.

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

static

virtual vtkObjectBase* vtkSplineRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkCurveRepresentation.

vtkSplineRepresentation* vtkSplineRepresentation::NewInstance ( ) const

void vtkSplineRepresentation::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 vtkCurveRepresentation.

void vtkSplineRepresentation::GetPolyData ( vtkPolyData * pd )

virtual

Grab the polydata (including points) that defines the spline. The polydata consists of points and line segments numbering Resolution + 1 and Resolution, respectively. Points are guaranteed to be up-to-date when either the InteractionEvent or EndInteraction events are invoked. The user provides the vtkPolyData and the points and polyline are added to it.

Implements vtkCurveRepresentation.

virtual void vtkSplineRepresentation::SetNumberOfHandles ( int npts )

virtual

Set the number of handles for this widget.

Implements vtkCurveRepresentation.

void vtkSplineRepresentation::SetResolution ( int resolution )

Set/Get the number of line segments representing the spline for this widget.

virtual int vtkSplineRepresentation::GetResolution ( )

virtual

Set/Get the number of line segments representing the spline for this widget.

virtual void vtkSplineRepresentation::SetParametricSpline ( vtkParametricSpline * )

virtual

Set the parametric spline object. Through vtkParametricSpline's API, the user can supply and configure one of two types of spline: vtkCardinalSpline, vtkKochanekSpline. The widget controls the open or closed configuration of the spline. WARNING: The widget does not enforce internal consistency so that all three are of the same type.

virtual vtkParametricSpline* vtkSplineRepresentation::GetParametricSpline ( )

virtual

Set the parametric spline object. Through vtkParametricSpline's API, the user can supply and configure one of two types of spline: vtkCardinalSpline, vtkKochanekSpline. The widget controls the open or closed configuration of the spline. WARNING: The widget does not enforce internal consistency so that all three are of the same type.

vtkDoubleArray* vtkSplineRepresentation::GetHandlePositions ( )

virtual

Get the position of the spline handles.

Implements vtkCurveRepresentation.

double vtkSplineRepresentation::GetSummedLength ( )

virtual

Get the approximate vs. the true arc length of the spline. Calculated as the summed lengths of the individual straight line segments. Use SetResolution to control the accuracy.

Implements vtkCurveRepresentation.

void vtkSplineRepresentation::InitializeHandles ( vtkPoints * points )

virtual

Convenience method to allocate and set the handles from a vtkPoints instance. If the first and last points are the same, the spline sets Closed to the on InteractionState and disregards the last point, otherwise Closed remains unchanged.

Implements vtkCurveRepresentation.

virtual void vtkSplineRepresentation::BuildRepresentation ( )

virtual

These are methods that satisfy vtkWidgetRepresentation's API. Note that a version of place widget is available where the center and handle position are specified.

Implements vtkCurveRepresentation.

virtual void vtkSplineRepresentation::InsertHandleOnLine ( double * pos )

protectedvirtual

Implements vtkCurveRepresentation.

Member Data Documentation

vtkParametricSpline* vtkSplineRepresentation::ParametricSpline

protected

Definition at line 109 of file vtkSplineRepresentation.h.

vtkParametricFunctionSource* vtkSplineRepresentation::ParametricFunctionSource

protected

Definition at line 110 of file vtkSplineRepresentation.h.

int vtkSplineRepresentation::Resolution

protected

Definition at line 113 of file vtkSplineRepresentation.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Interaction/Widgets/vtkSplineRepresentation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation