vtkPolyLineRepresentation Class Reference

vtkWidgetRepresentation for a poly line. More...

#include <vtkPolyLineRepresentation.h>

Inheritance diagram for vtkPolyLineRepresentation:

Collaboration diagram for vtkPolyLineRepresentation:

Public Types
typedef vtkCurveRepresentation	Superclass
Public Types inherited from vtkCurveRepresentation
enum	InteractionStateType {   Outside = 0 , OnHandle , OnLine , Moving ,   Scaling , Spinning , Inserting , Erasing ,   Pushing }
typedef vtkWidgetRepresentation	Superclass
Public Types inherited from vtkWidgetRepresentation
enum	Axis {   NONE = -1 , XAxis = 0 , YAxis = 1 , ZAxis = 2 ,   Custom = 3 }
	Axis labels. More...
typedef vtkProp	Superclass
	Standard methods for instances of this class.
Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instances of this class.
vtkPolyLineRepresentation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	GetPolyData (vtkPolyData *pd) override
	Grab the polydata (including points) that defines the poly line.
void	SetNumberOfHandles (int npts) override
	Set the number of handles for this widget.
vtkDoubleArray *	GetHandlePositions () override
	Get the positions of the handles.
double	GetSummedLength () override
	Get the true length of the poly line.
void	InitializeHandles (vtkPoints *points) override
	Convenience method to allocate and set the handles from a vtkPoints instance.
void	BuildRepresentation () override
	Build the representation for the poly line.
Public Member Functions inherited from vtkCurveRepresentation
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instances of this class.
vtkCurveRepresentation *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetPlaneSource (vtkPlaneSource *plane)
	Set up a reference to a vtkPlaneSource that could be from another widget object, e.g.
virtual void	SetProjectionNormal (int)
virtual int	GetProjectionNormal ()
void	SetProjectionNormalToXAxes ()
void	SetProjectionNormalToYAxes ()
void	SetProjectionNormalToZAxes ()
void	SetProjectionNormalToOblique ()
virtual void	GetPolyData (vtkPolyData *pd)=0
	Grab the polydata (including points) that defines the interpolating curve.
vtkTypeBool	IsClosed ()
	Convenience method to determine whether the curve is closed in a geometric sense.
virtual double	GetSummedLength ()=0
	Get the approximate vs.
virtual void	InitializeHandles (vtkPoints *points)=0
	Convenience method to allocate and set the handles from a vtkPoints instance.
void	SetLineColor (double r, double g, double b)
	Convenience method to set the line color.
void	RegisterPickers () override
	Register internal Pickers in the Picking Manager.
void	GetActors (vtkPropCollection *) override
	Methods to make this class behave as a vtkProp.
virtual void	SetInteractionState (int)
	Set the interaction state.
virtual void	SetProjectToPlane (vtkTypeBool)
	Force the widget to be projected onto one of the orthogonal planes.
virtual vtkTypeBool	GetProjectToPlane ()
	Force the widget to be projected onto one of the orthogonal planes.
virtual void	ProjectToPlaneOn ()
	Force the widget to be projected onto one of the orthogonal planes.
virtual void	ProjectToPlaneOff ()
	Force the widget to be projected onto one of the orthogonal planes.
void	SetProjectionPosition (double position)
	Set the position of poly line handles and points in terms of a plane's position.
virtual double	GetProjectionPosition ()
	Set the position of poly line handles and points in terms of a plane's position.
virtual vtkProperty *	GetHandleProperty ()
	Set/Get the handle properties (the spheres are the handles).
virtual vtkProperty *	GetSelectedHandleProperty ()
	Set/Get the handle properties (the spheres are the handles).
virtual vtkProperty *	GetLineProperty ()
	Set/Get the line properties.
virtual vtkProperty *	GetSelectedLineProperty ()
	Set/Get the line properties.
virtual int	GetNumberOfHandles ()
	Set/Get the number of handles for this widget.
virtual void	SetDirectional (bool val)
	Set the representation to be directional or not.
virtual bool	GetDirectional ()
	Set the representation to be directional or not.
virtual void	DirectionalOn ()
	Set the representation to be directional or not.
virtual void	DirectionalOff ()
	Set the representation to be directional or not.
virtual void	SetHandlePosition (int handle, double x, double y, double z)
	Set/Get the position of the handles.
virtual void	SetHandlePosition (int handle, double xyz[3])
	Set/Get the position of the handles.
virtual void	GetHandlePosition (int handle, double xyz[3])
	Set/Get the position of the handles.
virtual double *	GetHandlePosition (int handle)
	Set/Get the position of the handles.
void	SetClosed (vtkTypeBool closed)
	Control whether the curve is open or closed.
virtual vtkTypeBool	GetClosed ()
	Control whether the curve is open or closed.
virtual void	ClosedOn ()
	Control whether the curve is open or closed.
virtual void	ClosedOff ()
	Control whether the curve is open or closed.
int	ComputeInteractionState (int X, int Y, int modify=0) override
	These are methods that satisfy vtkWidgetRepresentation API.
void	StartWidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation API.
void	WidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation API.
void	EndWidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation API.
double *	GetBounds () override
	These are methods that satisfy vtkWidgetRepresentation API.
void	ReleaseGraphicsResources (vtkWindow *) override
	Methods supporting, and required by, the rendering process.
int	RenderOpaqueGeometry (vtkViewport *) override
	Methods supporting, and required by, the rendering process.
int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	Methods supporting, and required by, the rendering process.
int	RenderOverlay (vtkViewport *) override
	Methods supporting, and required by, the rendering process.
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Methods supporting, and required by, the rendering process.
void	SetInteractionColor (double, double, double)
	Set the color when unselected and selected.
void	SetInteractionColor (double c[3])
	Set the color when unselected and selected.
void	SetForegroundColor (double, double, double)
	Set the color when unselected and selected.
void	SetForegroundColor (double c[3])
	Set the color when unselected and selected.
void	SetCurrentHandleIndex (int index)
	Get/Set the current handle index.
virtual int	GetCurrentHandleIndex ()
	Get/Set the current handle index.
virtual int	GetTranslationAxis ()
	Gets/Sets the constraint axis for translations.
virtual void	SetTranslationAxis (int)
	Gets/Sets the constraint axis for translations.
void	SetXTranslationAxisOn ()
	Toggles constraint translation axis on/off.
void	SetYTranslationAxisOn ()
	Toggles constraint translation axis on/off.
void	SetZTranslationAxisOn ()
	Toggles constraint translation axis on/off.
void	SetTranslationAxisOff ()
	Toggles constraint translation axis on/off.
bool	IsTranslationConstrained ()
	Returns true if ConstrainedAxis.
Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PlaceWidget (double vtkNotUsed(bounds)[6])
	The following is a suggested API for widget representations.
virtual void	StartWidgetInteraction (double eventPos[2])
virtual void	WidgetInteraction (double newEventPos[2])
virtual void	EndWidgetInteraction (double newEventPos[2])
virtual int	ComputeInteractionState (int X, int Y, int modify=0)
virtual int	GetInteractionState ()
virtual void	Highlight (int vtkNotUsed(highlightOn))
double *	GetBounds () override
	Methods to make this class behave as a vtkProp.
void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkProp.
void	GetActors (vtkPropCollection *) override
	For some exporters and other other operations we must be able to collect all the actors or volumes.
void	GetActors2D (vtkPropCollection *) override
void	GetVolumes (vtkPropCollection *) override
void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
int	RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override
int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override
int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override
int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override
vtkTypeBool	HasTranslucentPolygonalGeometry () override
	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.
virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.
virtual void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.
virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.
virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.
void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.
virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.
virtual void	SetRenderer (vtkRenderer *ren)
	Subclasses of vtkWidgetRepresentation must implement these methods.
virtual vtkRenderer *	GetRenderer ()
	Subclasses of vtkWidgetRepresentation must implement these methods.
virtual void	StartComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
virtual void	ComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
virtual void	EndComplexInteraction (vtkRenderWindowInteractor *, vtkAbstractWidget *, unsigned long, void *)
virtual int	ComputeComplexInteractionState (vtkRenderWindowInteractor *iren, vtkAbstractWidget *widget, unsigned long event, void *callData, int modify=0)
virtual void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
virtual double	GetPlaceFactor ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
virtual double	GetHandleSize ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
virtual vtkTypeBool	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).
virtual void	SetNeedToRender (vtkTypeBool)
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
virtual void	NeedToRenderOn ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
virtual void	NeedToRenderOff ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
vtkWidgetRepresentation *	NewInstance () const
	Standard methods for instances of this class.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instances of this class.
Public Member Functions inherited from vtkProp
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkProp *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes.
virtual void	GetActors2D (vtkPropCollection *)
virtual void	GetVolumes (vtkPropCollection *)
virtual void	Pick ()
	Method fires PickEvent if the prop is picked.
virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently.
virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
virtual void	ShallowCopy (vtkProp *prop)
	Shallow copy of this vtkProp.
virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering.
virtual vtkMatrix4x4 *	GetMatrix ()
virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys.
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.
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int	RenderVolumetricGeometry (vtkViewport *)
virtual int	RenderOverlay (vtkViewport *)
virtual bool	RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys.
virtual bool	RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys.
virtual vtkTypeBool	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.
virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry.
virtual void	ReleaseGraphicsResources (vtkWindow *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
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.
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.
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.
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.
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.
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.
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.
virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers
virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp.
virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp.
virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp.
virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable.
virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable.
virtual void	PickableOn ()
	Set/Get the pickable instance variable.
virtual void	PickableOff ()
	Set/Get the pickable instance variable.
virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable.
virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable.
virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable.
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().
virtual bool	GetUseBounds ()
	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().
virtual void	UseBoundsOn ()
	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().
virtual void	UseBoundsOff ()
	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().
virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker).
virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys.
virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys.
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.
virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.
virtual int	GetNumberOfConsumers ()
	Get the number of consumers.
void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,.
int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,.
virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property.
virtual vtkShaderProperty *	GetShaderProperty ()
	Set/Get the shader property.
virtual bool	IsRenderingTranslucentPolygonalGeometry ()
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
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.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
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.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions
static vtkPolyLineRepresentation *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPolyLineRepresentation *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkCurveRepresentation
static vtkTypeBool	IsTypeOf (const char *type)
static vtkCurveRepresentation *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class.
static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class.
Static Public Member Functions inherited from vtkProp
static vtkTypeBool	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.
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.
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.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instances of this class.
	vtkPolyLineRepresentation ()
	~vtkPolyLineRepresentation () override
int	InsertHandleOnLine (double *pos) override
	Specialized method to insert a handle on the poly line.
void	ClearHandles ()
	Delete all the handles.
void	AllocateHandles (int npts)
	Allocate/Reallocate the handles according to npts.
void	CreateDefaultHandles (int npts)
	Create npts default handles.
void	ReconfigureHandles (int npts)
	Recreate the handles according to a number of points equal to npts.
vtkActor *	GetHandleActor (int index) override
vtkHandleSource *	GetHandleSource (int index) override
int	GetHandleIndex (vtkProp *prop) override
	returns handle index or -1 on fail
Protected Member Functions inherited from vtkCurveRepresentation
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instances of this class.
	vtkCurveRepresentation ()
	~vtkCurveRepresentation () override
void	ProjectPointsToPlane ()
void	ProjectPointsToOrthoPlane ()
void	ProjectPointsToObliquePlane ()
void	HighlightLine (int highlight)
int	HighlightHandle (vtkProp *prop)
virtual vtkActor *	GetHandleActor (int index)=0
virtual vtkHandleSource *	GetHandleSource (int index)=0
virtual int	GetHandleIndex (vtkProp *prop)=0
	returns handle index or -1 on fail
virtual void	SizeHandles ()
virtual int	InsertHandleOnLine (double *pos)=0
	Returns the position of insertion or -1 on fail.
virtual void	PushHandle (double *pos)
virtual void	EraseHandle (const int &)
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 () override
vtkVector3d	GetWorldPoint (vtkAbstractPicker *picker, double screenPos[2])
	Return the given screen point in world coordinates, based on picked position.
void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])
vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the widget representation currently belong.
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.
vtkAssemblyPath *	GetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)
bool	NearbyEvent (int X, int Y, double bounds[6])
double	SizeHandlesRelativeToViewport (double factor, double pos[3])
double	SizeHandlesInPixels (double factor, double pos[3])
void	UpdatePropPose (vtkProp3D *prop, const double *pos1, const double *orient1, const double *pos2, const double *orient2)
Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkProp ()
	~vtkProp () override
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=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	ObjectFinalize ()
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkNew< vtkPolyLineSource >	PolyLineSource
Protected Attributes inherited from vtkCurveRepresentation
double	LastEventPosition [3]
double	Bounds [6]
int	ProjectionNormal
double	ProjectionPosition
vtkTypeBool	ProjectToPlane
vtkPlaneSource *	PlaneSource
int	NumberOfHandles = 0
vtkTypeBool	Closed
vtkActor *	LineActor
vtkCellPicker *	HandlePicker
vtkCellPicker *	LinePicker
double	LastPickPosition [3]
vtkActor *	CurrentHandle
int	CurrentHandleIndex
bool	FirstSelected
vtkTransform *	Transform
bool	Directional = false
vtkProperty *	HandleProperty
vtkProperty *	SelectedHandleProperty
vtkProperty *	LineProperty
vtkProperty *	SelectedLineProperty
double	Centroid [3]
int	TranslationAxis
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
vtkTypeBool	NeedToRender
vtkTimeStamp	BuildTime
vtkNew< vtkTransform >	TempTransform
vtkNew< vtkMatrix4x4 >	TempMatrix
Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility
vtkTypeBool	Pickable
vtkTypeBool	Dragable
bool	UseBounds
double	AllocatedRenderTime
double	EstimatedRenderTime
double	SavedEstimatedRenderTime
double	RenderTimeMultiplier
int	NumberOfConsumers
vtkObject **	Consumers
vtkAssemblyPaths *	Paths
vtkInformation *	PropertyKeys
vtkShaderProperty *	ShaderProperty
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

vtkWidgetRepresentation for a poly line.

vtkPolyLineRepresentation is a vtkCurveRepresentation for a poly line. This 3D widget defines a poly line that can be interactively placed in a scene. The poly line has handles, the number of which can be changed, plus the widget can be picked on the poly line itself to translate or rotate it in the scene. Based on vtkCurveRepresentation

See also

vtkSplineRepresentation

Tests:

vtkPolyLineRepresentation (Tests)

Definition at line 31 of file vtkPolyLineRepresentation.h.

Member Typedef Documentation

Superclass

typedef vtkCurveRepresentation vtkPolyLineRepresentation::Superclass

Definition at line 36 of file vtkPolyLineRepresentation.h.

Constructor & Destructor Documentation

vtkPolyLineRepresentation()

vtkPolyLineRepresentation::vtkPolyLineRepresentation ( )

protected

~vtkPolyLineRepresentation()

vtkPolyLineRepresentation::~vtkPolyLineRepresentation ( )

overrideprotected

Member Function Documentation

New()

static vtkPolyLineRepresentation * vtkPolyLineRepresentation::New ( )

static

IsTypeOf()

static vtkTypeBool vtkPolyLineRepresentation::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkPolyLineRepresentation::IsA ( const char *  type )

virtual

Standard methods for instances of this class.

Reimplemented from vtkCurveRepresentation.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkPolyLineRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instances of this class.

Reimplemented from vtkCurveRepresentation.

NewInstance()

vtkPolyLineRepresentation * vtkPolyLineRepresentation::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

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.

GetPolyData()

void vtkPolyLineRepresentation::GetPolyData ( vtkPolyData *  pd )

overridevirtual

Grab the polydata (including points) that defines the poly line.

polydata consists of points and line segments between consecutive points. 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.

SetNumberOfHandles()

void vtkPolyLineRepresentation::SetNumberOfHandles ( int  npts )

overridevirtual

Set the number of handles for this widget.

Implements vtkCurveRepresentation.

GetHandlePositions()

vtkDoubleArray * vtkPolyLineRepresentation::GetHandlePositions ( )

overridevirtual

Get the positions of the handles.

Implements vtkCurveRepresentation.

GetSummedLength()

double vtkPolyLineRepresentation::GetSummedLength ( )

overridevirtual

Get the true length of the poly line.

Calculated as the summed lengths of the individual straight line segments.

Implements vtkCurveRepresentation.

InitializeHandles()

void vtkPolyLineRepresentation::InitializeHandles ( vtkPoints *  points )

overridevirtual

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

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

Implements vtkCurveRepresentation.

BuildRepresentation()

void vtkPolyLineRepresentation::BuildRepresentation ( )

overridevirtual

Build the representation for the poly line.

Implements vtkCurveRepresentation.

InsertHandleOnLine()

int vtkPolyLineRepresentation::InsertHandleOnLine ( double *  pos )

overrideprotectedvirtual

Specialized method to insert a handle on the poly line.

Implements vtkCurveRepresentation.

ClearHandles()

void vtkPolyLineRepresentation::ClearHandles ( )

protected

Delete all the handles.

AllocateHandles()

void vtkPolyLineRepresentation::AllocateHandles ( int  npts )

protected

Allocate/Reallocate the handles according to npts.

CreateDefaultHandles()

void vtkPolyLineRepresentation::CreateDefaultHandles ( int  npts )

protected

Create npts default handles.

ReconfigureHandles()

void vtkPolyLineRepresentation::ReconfigureHandles ( int  npts )

protected

Recreate the handles according to a number of points equal to npts.

It uses the current spline to recompute the positions of the new handles.

GetHandleActor()

vtkActor * vtkPolyLineRepresentation::GetHandleActor ( int  index )

overrideprotectedvirtual

Implements vtkCurveRepresentation.

GetHandleSource()

vtkHandleSource * vtkPolyLineRepresentation::GetHandleSource ( int  index )

overrideprotectedvirtual

Implements vtkCurveRepresentation.

GetHandleIndex()

int vtkPolyLineRepresentation::GetHandleIndex ( vtkProp *  prop )

overrideprotectedvirtual

returns handle index or -1 on fail

Implements vtkCurveRepresentation.

Member Data Documentation

PolyLineSource

vtkNew<vtkPolyLineSource> vtkPolyLineRepresentation::PolyLineSource

protected

Definition at line 83 of file vtkPolyLineRepresentation.h.

---

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

• Interaction/Widgets/vtkPolyLineRepresentation.h