vtkWidgetRepresentation base class for a widget that represents an curve that connects control points. More...

#include <vtkCurveRepresentation.h>

Inheritance diagram for vtkCurveRepresentation:

Collaboration diagram for vtkCurveRepresentation:

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

typedef vtkWidgetRepresentation	Superclass

Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass
	Standard methods for instances of this class. More...

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCurveRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	SetInteractionState (int)
	Set the interaction state. More...

virtual void	SetProjectToPlane (int)
	Force the widget to be projected onto one of the orthogonal planes. More...

virtual int	GetProjectToPlane ()

virtual void	ProjectToPlaneOn ()

virtual void	ProjectToPlaneOff ()

void	SetPlaneSource (vtkPlaneSource *plane)
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g. More...

virtual void	SetProjectionNormal (int)

virtual int	GetProjectionNormal ()

void	SetProjectionNormalToXAxes ()

void	SetProjectionNormalToYAxes ()

void	SetProjectionNormalToZAxes ()

void	SetProjectionNormalToOblique ()

void	SetProjectionPosition (double position)
	Set the position of poly line handles and points in terms of a plane's position. More...

virtual double	GetProjectionPosition ()

virtual void	GetPolyData (vtkPolyData *pd)=0
	Grab the polydata (including points) that defines the interpolating curve. More...

virtual vtkProperty *	GetHandleProperty ()
	Set/Get the handle properties (the spheres are the handles). More...

virtual vtkProperty *	GetSelectedHandleProperty ()

virtual vtkProperty *	GetLineProperty ()
	Set/Get the line properties. More...

virtual vtkProperty *	GetSelectedLineProperty ()

virtual void	SetNumberOfHandles (int npts)=0
	Set/Get the number of handles for this widget. More...

virtual int	GetNumberOfHandles ()

virtual void	SetHandlePosition (int handle, double x, double y, double z)
	Set/Get the position of the handles. More...

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

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

virtual double *	GetHandlePosition (int handle)

virtual vtkDoubleArray *	GetHandlePositions ()=0

void	SetClosed (int closed)
	Control whether the curve is open or closed. More...

virtual int	GetClosed ()

virtual void	ClosedOn ()

virtual void	ClosedOff ()

int	IsClosed ()
	Convenience method to determine whether the curve is closed in a geometric sense. More...

virtual double	GetSummedLength ()=0
	Get the approximate vs. More...

virtual void	InitializeHandles (vtkPoints *points)=0
	Convenience method to allocate and set the handles from a vtkPoints instance. More...

virtual void	BuildRepresentation ()=0
	These are methods that satisfy vtkWidgetRepresentation's API. More...

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 ()
	Methods to make this class behave as a vtkProp. More...

virtual void	ReleaseGraphicsResources (vtkWindow *)
	Methods supporting, and required by, the rendering process. More...

virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More...

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderOverlay (vtkViewport *)

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

void	SetLineColor (double r, double g, double b)
	Convenience method to set the line color. More...

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

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual void	SetRenderer (vtkRenderer *ren)
	Subclasses of vtkWidgetRepresentation must implement these methods. More...

virtual vtkRenderer *	GetRenderer ()

virtual void	PlaceWidget (double *vtkNotUsed(bounds[6]))
	The following is a suggested API for widget representations. More...

virtual int	GetInteractionState ()

virtual void	Highlight (int vtkNotUsed(highlightOn))

virtual void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

virtual double	GetPlaceFactor ()

virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...

virtual double	GetHandleSize ()

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

virtual void	SetNeedToRender (int)

virtual void	NeedToRenderOn ()

virtual void	NeedToRenderOff ()

virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp. More...

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

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

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

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	SetVisibility (int)
	Set/Get visibility of this vtkProp. More...

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)
	Set/Get the pickable instance variable. More...

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	Pick ()
	Method fires PickEvent if the prop is picked. More...

virtual void	SetDragable (int)
	Set/Get the value of the dragable instance variable. More...

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently. More...

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys. More...

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys. More...

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys. More...

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...

virtual int	GetNumberOfConsumers ()
	Get the number of consumers. More...

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

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)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

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
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
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 ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCurveRepresentation ()

	~vtkCurveRepresentation ()

void	ProjectPointsToPlane ()

void	ProjectPointsToOrthoPlane ()

void	ProjectPointsToObliquePlane ()

void	HighlightLine (int highlight)

void	Initialize ()

int	HighlightHandle (vtkProp *prop)

virtual void	SizeHandles ()

virtual void	InsertHandleOnLine (double *pos)=0

void	EraseHandle (const int &)

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

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 ()
	Unregister internal pickers from the Picking Manager. More...

virtual void	PickersModified ()
	Update the pickers registered in the Picking Manager when pickers are modified. More...

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the widget representation currently belong. More...

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. More...

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

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

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

vtkWidgetRepresentation base class for a widget that represents an curve that connects control points.

Base class for widgets used to define curves from points, such as vtkPolyLineRepresentation and vtkSplineRepresentation. This class uses handles, the number of which can be changed, to represent the points that define the curve. The handles can be picked can be picked on the curve itself to translate or rotate it in the scene.

Definition at line 49 of file vtkCurveRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWidgetRepresentation vtkCurveRepresentation::Superclass

Definition at line 52 of file vtkCurveRepresentation.h.

Member Enumeration Documentation

◆ _InteractionState

enum vtkCurveRepresentation::_InteractionState

Enumerator
Outside
OnHandle
OnLine
Moving
Scaling
Spinning
Inserting
Erasing

Definition at line 56 of file vtkCurveRepresentation.h.

Constructor & Destructor Documentation

◆ vtkCurveRepresentation()

vtkCurveRepresentation::vtkCurveRepresentation ( )

protected

◆ ~vtkCurveRepresentation()

vtkCurveRepresentation::~vtkCurveRepresentation ( )

protected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkCurveRepresentation::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 vtkWidgetRepresentation.

Reimplemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCurveRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ NewInstance()

vtkCurveRepresentation* vtkCurveRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetInteractionState()

virtual void vtkCurveRepresentation::SetInteractionState ( int )

virtual

Set the interaction state.

◆ SetProjectToPlane()

virtual void vtkCurveRepresentation::SetProjectToPlane ( int )

virtual

Force the widget to be projected onto one of the orthogonal planes.

Remember that when the InteractionState changes, a ModifiedEvent is invoked. This can be used to snap the curve to the plane if it is originally not aligned. The normal in SetProjectionNormal is 0,1,2 for YZ,XZ,XY planes respectively and 3 for arbitrary oblique planes when the widget is tied to a vtkPlaneSource.

◆ GetProjectToPlane()

virtual int vtkCurveRepresentation::GetProjectToPlane ( )

virtual

◆ ProjectToPlaneOn()

virtual void vtkCurveRepresentation::ProjectToPlaneOn ( )

virtual

◆ ProjectToPlaneOff()

virtual void vtkCurveRepresentation::ProjectToPlaneOff ( )

virtual

◆ SetPlaneSource()

void vtkCurveRepresentation::SetPlaneSource ( vtkPlaneSource * plane )

Set up a reference to a vtkPlaneSource that could be from another widget object, e.g.

a vtkPolyDataSourceWidget.

◆ SetProjectionNormal()

virtual void vtkCurveRepresentation::SetProjectionNormal ( int )

virtual

◆ GetProjectionNormal()

virtual int vtkCurveRepresentation::GetProjectionNormal ( )

virtual

◆ SetProjectionNormalToXAxes()

void vtkCurveRepresentation::SetProjectionNormalToXAxes ( )

inline

Definition at line 97 of file vtkCurveRepresentation.h.

◆ SetProjectionNormalToYAxes()

void vtkCurveRepresentation::SetProjectionNormalToYAxes ( )

inline

Definition at line 99 of file vtkCurveRepresentation.h.

◆ SetProjectionNormalToZAxes()

void vtkCurveRepresentation::SetProjectionNormalToZAxes ( )

inline

Definition at line 101 of file vtkCurveRepresentation.h.

◆ SetProjectionNormalToOblique()

void vtkCurveRepresentation::SetProjectionNormalToOblique ( )

inline

Definition at line 103 of file vtkCurveRepresentation.h.

◆ SetProjectionPosition()

void vtkCurveRepresentation::SetProjectionPosition ( double position )

Set the position of poly line handles and points in terms of a plane's position.

i.e., if ProjectionNormal is 0, all of the x-coordinate values of the points are set to position. Any value can be passed (and is ignored) to update the poly line points when Projection normal is set to 3 for arbritrary plane orientations.

◆ GetProjectionPosition()

virtual double vtkCurveRepresentation::GetProjectionPosition ( )

virtual

◆ GetPolyData()

virtual void vtkCurveRepresentation::GetPolyData ( vtkPolyData * pd )

pure virtual

Grab the polydata (including points) that defines the interpolating curve.

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.

Implemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ GetHandleProperty()

virtual vtkProperty* vtkCurveRepresentation::GetHandleProperty ( )

virtual

Set/Get the handle properties (the spheres are the handles).

The properties of the handles when selected and unselected can be manipulated.

◆ GetSelectedHandleProperty()

virtual vtkProperty* vtkCurveRepresentation::GetSelectedHandleProperty ( )

virtual

◆ GetLineProperty()

virtual vtkProperty* vtkCurveRepresentation::GetLineProperty ( )

virtual

Set/Get the line properties.

The properties of the line when selected and unselected can be manipulated.

◆ GetSelectedLineProperty()

virtual vtkProperty* vtkCurveRepresentation::GetSelectedLineProperty ( )

virtual

◆ SetNumberOfHandles()

virtual void vtkCurveRepresentation::SetNumberOfHandles ( int npts )

pure virtual

Set/Get the number of handles for this widget.

Implemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ GetNumberOfHandles()

virtual int vtkCurveRepresentation::GetNumberOfHandles ( )

virtual

◆ SetHandlePosition() [1/2]

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

virtual

Set/Get the position of the handles.

Call GetNumberOfHandles to determine the valid range of handle indices.

◆ SetHandlePosition() [2/2]

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

virtual

◆ GetHandlePosition() [1/2]

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

virtual

◆ GetHandlePosition() [2/2]

virtual double* vtkCurveRepresentation::GetHandlePosition ( int handle )

virtual

◆ GetHandlePositions()

virtual vtkDoubleArray* vtkCurveRepresentation::GetHandlePositions ( )

pure virtual

Implemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ SetClosed()

void vtkCurveRepresentation::SetClosed ( int closed )

Control whether the curve is open or closed.

A closed forms a continuous loop: the first and last points are the same. A minimum of 3 handles are required to form a closed loop.

◆ GetClosed()

virtual int vtkCurveRepresentation::GetClosed ( )

virtual

◆ ClosedOn()

virtual void vtkCurveRepresentation::ClosedOn ( )

virtual

◆ ClosedOff()

virtual void vtkCurveRepresentation::ClosedOff ( )

virtual

◆ IsClosed()

int vtkCurveRepresentation::IsClosed ( )

Convenience method to determine whether the curve is closed in a geometric sense.

The widget may be set "closed" but still be geometrically open (e.g., a straight line).

◆ GetSummedLength()

virtual double vtkCurveRepresentation::GetSummedLength ( )

pure virtual

Get the approximate vs.

the true arc length of the curve. Calculated as the summed lengths of the individual straight line segments. Use SetResolution to control the accuracy.

Implemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ InitializeHandles()

virtual void vtkCurveRepresentation::InitializeHandles ( vtkPoints * points )

pure virtual

Convenience method to allocate and set the handles from a vtkPoints instance.

If the first and last points are the same, the curve sets Closed to the on InteractionState and disregards the last point, otherwise Closed remains unchanged.

Implemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ BuildRepresentation()

virtual void vtkCurveRepresentation::BuildRepresentation ( )

pure 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 vtkWidgetRepresentation.

Implemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ ComputeInteractionState()

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

virtual

Reimplemented from vtkWidgetRepresentation.

◆ StartWidgetInteraction()

virtual void vtkCurveRepresentation::StartWidgetInteraction ( double e[2] )

virtual

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

virtual void vtkCurveRepresentation::WidgetInteraction ( double e[2] )

virtual

Reimplemented from vtkWidgetRepresentation.

◆ EndWidgetInteraction()

virtual void vtkCurveRepresentation::EndWidgetInteraction ( double e[2] )

virtual

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

virtual double* vtkCurveRepresentation::GetBounds ( void )

virtual

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

◆ ReleaseGraphicsResources()

virtual void vtkCurveRepresentation::ReleaseGraphicsResources ( vtkWindow * )

virtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkWidgetRepresentation.

◆ RenderOpaqueGeometry()

virtual int vtkCurveRepresentation::RenderOpaqueGeometry ( vtkViewport * )

virtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves.

There are four key render methods in vtk and they correspond to four different points in the rendering cycle. Any given prop may implement one or more of these methods. The first method is intended for rendering all opaque geometry. The second method is intended for rendering all translucent polygonal geometry. The third one is intended for rendering all translucent volumetric geometry. Most of the volume rendering mappers draw their results during this third method. The last method is to render any 2D annotation or overlays. Each of these methods return an integer value indicating whether or not this render method was applied to this data.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

virtual int vtkCurveRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport * )

virtual

Reimplemented from vtkProp.

◆ RenderOverlay()

virtual int vtkCurveRepresentation::RenderOverlay ( vtkViewport * )

virtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

virtual int vtkCurveRepresentation::HasTranslucentPolygonalGeometry ( )

virtual

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

◆ SetLineColor()

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

Convenience method to set the line color.

Ideally one should use GetLineProperty()->SetColor().

◆ ProjectPointsToPlane()

void vtkCurveRepresentation::ProjectPointsToPlane ( )

protected

◆ ProjectPointsToOrthoPlane()

void vtkCurveRepresentation::ProjectPointsToOrthoPlane ( )

protected

◆ ProjectPointsToObliquePlane()

void vtkCurveRepresentation::ProjectPointsToObliquePlane ( )

protected

◆ HighlightLine()

void vtkCurveRepresentation::HighlightLine ( int highlight )

protected

◆ Initialize()

void vtkCurveRepresentation::Initialize ( )

protected

◆ HighlightHandle()

int vtkCurveRepresentation::HighlightHandle ( vtkProp * prop )

protected

◆ SizeHandles()

virtual void vtkCurveRepresentation::SizeHandles ( )

protectedvirtual

◆ InsertHandleOnLine()

virtual void vtkCurveRepresentation::InsertHandleOnLine ( double * pos )

protectedpure virtual

Implemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ EraseHandle()

void vtkCurveRepresentation::EraseHandle ( const int & )

protected

◆ RegisterPickers()

virtual void vtkCurveRepresentation::RegisterPickers ( )

protectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

◆ MovePoint()

void vtkCurveRepresentation::MovePoint	(	double *	p1,
		double *	p2
	)

protected

◆ Scale()

void vtkCurveRepresentation::Scale	(	double *	p1,
		double *	p2,
		int	X,
		int	Y
	)

protected

◆ Translate()

void vtkCurveRepresentation::Translate	(	double *	p1,
		double *	p2
	)

protected

◆ Spin()

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

protected

◆ CreateDefaultProperties()

void vtkCurveRepresentation::CreateDefaultProperties ( )

protected

◆ CalculateCentroid()

void vtkCurveRepresentation::CalculateCentroid ( )

protected

Member Data Documentation

◆ LastEventPosition

double vtkCurveRepresentation::LastEventPosition[3]

protected

Definition at line 233 of file vtkCurveRepresentation.h.

◆ Bounds

double vtkCurveRepresentation::Bounds[6]

protected

Definition at line 234 of file vtkCurveRepresentation.h.

◆ ProjectionNormal

int vtkCurveRepresentation::ProjectionNormal

protected

Definition at line 237 of file vtkCurveRepresentation.h.

◆ ProjectionPosition

double vtkCurveRepresentation::ProjectionPosition

protected

Definition at line 238 of file vtkCurveRepresentation.h.

◆ ProjectToPlane

int vtkCurveRepresentation::ProjectToPlane

protected

Definition at line 239 of file vtkCurveRepresentation.h.

◆ PlaneSource

vtkPlaneSource* vtkCurveRepresentation::PlaneSource

protected

Definition at line 240 of file vtkCurveRepresentation.h.

◆ NumberOfHandles

int vtkCurveRepresentation::NumberOfHandles

protected

Definition at line 247 of file vtkCurveRepresentation.h.

◆ Closed

int vtkCurveRepresentation::Closed

protected

Definition at line 248 of file vtkCurveRepresentation.h.

◆ LineActor

vtkActor* vtkCurveRepresentation::LineActor

protected

Definition at line 251 of file vtkCurveRepresentation.h.

◆ Handle

vtkActor** vtkCurveRepresentation::Handle

protected

Definition at line 255 of file vtkCurveRepresentation.h.

◆ HandleGeometry

vtkSphereSource** vtkCurveRepresentation::HandleGeometry

protected

Definition at line 256 of file vtkCurveRepresentation.h.

◆ HandlePicker

vtkCellPicker* vtkCurveRepresentation::HandlePicker

protected

Definition at line 264 of file vtkCurveRepresentation.h.

◆ LinePicker

vtkCellPicker* vtkCurveRepresentation::LinePicker

protected

Definition at line 265 of file vtkCurveRepresentation.h.

◆ LastPickPosition

double vtkCurveRepresentation::LastPickPosition[3]

protected

Definition at line 266 of file vtkCurveRepresentation.h.

◆ CurrentHandle

vtkActor* vtkCurveRepresentation::CurrentHandle

protected

Definition at line 267 of file vtkCurveRepresentation.h.

◆ CurrentHandleIndex

int vtkCurveRepresentation::CurrentHandleIndex

protected

Definition at line 268 of file vtkCurveRepresentation.h.

◆ Transform

vtkTransform* vtkCurveRepresentation::Transform

protected

Definition at line 280 of file vtkCurveRepresentation.h.

◆ HandleProperty

vtkProperty* vtkCurveRepresentation::HandleProperty

protected

Definition at line 284 of file vtkCurveRepresentation.h.

◆ SelectedHandleProperty

vtkProperty* vtkCurveRepresentation::SelectedHandleProperty

protected

Definition at line 285 of file vtkCurveRepresentation.h.

◆ LineProperty

vtkProperty* vtkCurveRepresentation::LineProperty

protected

Definition at line 286 of file vtkCurveRepresentation.h.

◆ SelectedLineProperty

vtkProperty* vtkCurveRepresentation::SelectedLineProperty

protected

Definition at line 287 of file vtkCurveRepresentation.h.

◆ Centroid

double vtkCurveRepresentation::Centroid[3]

protected

Definition at line 291 of file vtkCurveRepresentation.h.

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

dox/Interaction/Widgets/vtkCurveRepresentation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ _InteractionState

Constructor & Destructor Documentation

◆ vtkCurveRepresentation()

◆ ~vtkCurveRepresentation()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetInteractionState()

◆ SetProjectToPlane()

◆ GetProjectToPlane()

◆ ProjectToPlaneOn()

◆ ProjectToPlaneOff()

◆ SetPlaneSource()

◆ SetProjectionNormal()

◆ GetProjectionNormal()

◆ SetProjectionNormalToXAxes()

◆ SetProjectionNormalToYAxes()

◆ SetProjectionNormalToZAxes()

◆ SetProjectionNormalToOblique()

◆ SetProjectionPosition()

◆ GetProjectionPosition()

◆ GetPolyData()

◆ GetHandleProperty()

◆ GetSelectedHandleProperty()

◆ GetLineProperty()

◆ GetSelectedLineProperty()

◆ SetNumberOfHandles()

◆ GetNumberOfHandles()

◆ SetHandlePosition() [1/2]

◆ SetHandlePosition() [2/2]

◆ GetHandlePosition() [1/2]

◆ GetHandlePosition() [2/2]

◆ GetHandlePositions()

◆ SetClosed()

◆ GetClosed()

◆ ClosedOn()

◆ ClosedOff()

◆ IsClosed()

◆ GetSummedLength()

◆ InitializeHandles()

◆ BuildRepresentation()

◆ ComputeInteractionState()

◆ StartWidgetInteraction()

◆ WidgetInteraction()

◆ EndWidgetInteraction()

◆ GetBounds()

◆ ReleaseGraphicsResources()

◆ RenderOpaqueGeometry()

◆ RenderTranslucentPolygonalGeometry()

◆ RenderOverlay()

◆ HasTranslucentPolygonalGeometry()

◆ SetLineColor()

◆ ProjectPointsToPlane()

◆ ProjectPointsToOrthoPlane()

◆ ProjectPointsToObliquePlane()

◆ HighlightLine()

◆ Initialize()

◆ HighlightHandle()

◆ SizeHandles()

◆ InsertHandleOnLine()

◆ EraseHandle()

◆ RegisterPickers()

◆ MovePoint()

◆ Scale()

◆ Translate()

◆ Spin()

◆ CreateDefaultProperties()