VTK
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCurveRepresentation Class Referenceabstract

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

#include <vtkCurveRepresentation.h>

Inheritance diagram for vtkCurveRepresentation:
[legend]
Collaboration diagram for vtkCurveRepresentation:
[legend]

Classes

class  HandleSource
 

Public Types

enum  _InteractionState {
  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 }
 Axis labels. More...
 
typedef vtkProp Superclass
 Standard methods for instances of this class. More...
 
- Public Types inherited from vtkProp
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCurveRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 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 (vtkTypeBool)
 Force the widget to be projected onto one of the orthogonal planes. More...
 
virtual vtkTypeBool 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 vtkPropertyGetHandleProperty ()
 Set/Get the handle properties (the spheres are the handles). More...
 
virtual vtkPropertyGetSelectedHandleProperty ()
 
virtual vtkPropertyGetLineProperty ()
 Set/Get the line properties. More...
 
virtual vtkPropertyGetSelectedLineProperty ()
 
virtual void SetNumberOfHandles (int npts)=0
 Set/Get the number of handles for this widget. More...
 
virtual int GetNumberOfHandles ()
 
void SetDirectionalLine (bool val)
 Sets the representation to be a directional curve with the end represented as a cone. More...
 
virtual bool GetDirectionalLine ()
 
virtual void DirectionalLineOn ()
 
virtual void DirectionalLineOff ()
 
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 vtkDoubleArrayGetHandlePositions ()=0
 
void SetClosed (vtkTypeBool closed)
 Control whether the curve is open or closed. More...
 
virtual vtkTypeBool GetClosed ()
 
virtual void ClosedOn ()
 
virtual void ClosedOff ()
 
vtkTypeBool 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...
 
void BuildRepresentation () override=0
 These are methods that satisfy vtkWidgetRepresentation's API. More...
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 
void StartWidgetInteraction (double e[2]) override
 
void WidgetInteraction (double e[2]) override
 
void EndWidgetInteraction (double e[2]) override
 
double * GetBounds () override
 Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...
 
void ReleaseGraphicsResources (vtkWindow *) override
 Methods supporting, and required by, the rendering process. More...
 
int RenderOpaqueGeometry (vtkViewport *) override
 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...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) override
 
int RenderOverlay (vtkViewport *) 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. More...
 
void SetLineColor (double r, double g, double b)
 Convenience method to set the line color. More...
 
void RegisterPickers () override
 Register internal Pickers in the Picking Manager. More...
 
void SetCurrentHandleIndex (int index)
 Get/Set the current handle index. More...
 
virtual int GetCurrentHandleIndex ()
 
virtual int GetTranslationAxis ()
 Gets/Sets the constraint axis for translations. More...
 
virtual void SetTranslationAxis (int)
 
void SetXTranslationAxisOn ()
 Toggles constraint translation axis on/off. More...
 
void SetYTranslationAxisOn ()
 
void SetZTranslationAxisOn ()
 
void SetTranslationAxisOff ()
 
bool IsTranslationConstrained ()
 Returns true if ContrainedAxis. More...
 
- Public Member Functions inherited from vtkWidgetRepresentation
vtkWidgetRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 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 ()
 
void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual void SetRenderer (vtkRenderer *ren)
 Subclasses of vtkWidgetRepresentation must implement these methods. More...
 
virtual vtkRendererGetRenderer ()
 
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 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). 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 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). More...
 
virtual void SetNeedToRender (vtkTypeBool)
 
virtual void NeedToRenderOn ()
 
virtual void NeedToRenderOff ()
 
double * GetBounds () override
 Methods to make this class behave as a vtkProp. More...
 
void ShallowCopy (vtkProp *prop) override
 Shallow copy of this vtkProp. More...
 
void GetActors (vtkPropCollection *) override
 For some exporters and other other operations we must be able to collect all the actors or volumes. More...
 
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. More...
 
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. More...
 
virtual void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
- Public Member Functions inherited from vtkProp
vtkPropNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetVisibility (vtkTypeBool)
 Set/Get visibility of this vtkProp. More...
 
virtual vtkTypeBool GetVisibility ()
 
virtual void VisibilityOn ()
 
virtual void VisibilityOff ()
 
virtual void SetPickable (vtkTypeBool)
 Set/Get the pickable instance variable. More...
 
virtual vtkTypeBool GetPickable ()
 
virtual void PickableOn ()
 
virtual void PickableOff ()
 
virtual void Pick ()
 Method fires PickEvent if the prop is picked. More...
 
virtual void SetDragable (vtkTypeBool)
 Set/Get the value of the dragable instance variable. More...
 
virtual vtkTypeBool 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 vtkAssemblyPathGetNextPath ()
 
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 vtkMatrix4x4GetMatrix ()
 
virtual vtkInformationGetPropertyKeys ()
 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 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. 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 void ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
 allows a prop to update a selections color buffers 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)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 
virtual bool IsRenderingTranslucentPolygonalGeometry ()
 
- 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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkCurveRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 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 vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCurveRepresentation ()
 
 ~vtkCurveRepresentation () override
 
void ProjectPointsToPlane ()
 
void ProjectPointsToOrthoPlane ()
 
void ProjectPointsToObliquePlane ()
 
void HighlightLine (int highlight)
 
void Initialize ()
 
int HighlightHandle (vtkProp *prop)
 
int GetHandleIndex (vtkProp *prop)
 
virtual void SizeHandles ()
 
virtual int InsertHandleOnLine (double *pos)=0
 Returns the position of insertion or -1 on fail. More...
 
virtual void PushHandle (double *pos)
 
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
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (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...
 
vtkAssemblyPathGetAssemblyPath3DPoint (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
 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. 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
 
vtkTypeBool ProjectToPlane
 
vtkPlaneSourcePlaneSource
 
int NumberOfHandles
 
vtkTypeBool Closed
 
vtkActorLineActor
 
vtkActor ** Handle
 
HandleSource ** HandleGeometry
 
vtkCellPickerHandlePicker
 
vtkCellPickerLinePicker
 
double LastPickPosition [3]
 
vtkActorCurrentHandle
 
int CurrentHandleIndex
 
bool FirstSelected
 
vtkTransformTransform
 
bool DirectionalLine
 
vtkPropertyHandleProperty
 
vtkPropertySelectedHandleProperty
 
vtkPropertyLineProperty
 
vtkPropertySelectedLineProperty
 
double Centroid [3]
 
int TranslationAxis
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRendererRenderer
 
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< vtkTransformTempTransform
 
vtkNew< vtkMatrix4x4TempMatrix
 
- 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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > 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 51 of file vtkCurveRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkCurveRepresentation.h.

Member Enumeration Documentation

◆ _InteractionState

Enumerator
Outside 
OnHandle 
OnLine 
Moving 
Scaling 
Spinning 
Inserting 
Erasing 
Pushing 

Definition at line 58 of file vtkCurveRepresentation.h.

Constructor & Destructor Documentation

◆ vtkCurveRepresentation()

vtkCurveRepresentation::vtkCurveRepresentation ( )
protected

◆ ~vtkCurveRepresentation()

vtkCurveRepresentation::~vtkCurveRepresentation ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstance()

vtkCurveRepresentation* vtkCurveRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ SetInteractionState()

virtual void vtkCurveRepresentation::SetInteractionState ( int  )
virtual

Set the interaction state.

◆ SetProjectToPlane()

virtual void vtkCurveRepresentation::SetProjectToPlane ( vtkTypeBool  )
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 vtkTypeBool 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 101 of file vtkCurveRepresentation.h.

◆ SetProjectionNormalToYAxes()

void vtkCurveRepresentation::SetProjectionNormalToYAxes ( )
inline

Definition at line 102 of file vtkCurveRepresentation.h.

◆ SetProjectionNormalToZAxes()

void vtkCurveRepresentation::SetProjectionNormalToZAxes ( )
inline

Definition at line 103 of file vtkCurveRepresentation.h.

◆ SetProjectionNormalToOblique()

void vtkCurveRepresentation::SetProjectionNormalToOblique ( )
inline

Definition at line 104 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 arbitrary 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

◆ SetDirectionalLine()

void vtkCurveRepresentation::SetDirectionalLine ( bool  val)

Sets the representation to be a directional curve with the end represented as a cone.

◆ GetDirectionalLine()

virtual bool vtkCurveRepresentation::GetDirectionalLine ( )
virtual

◆ DirectionalLineOn()

virtual void vtkCurveRepresentation::DirectionalLineOn ( )
virtual

◆ DirectionalLineOff()

virtual void vtkCurveRepresentation::DirectionalLineOff ( )
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

◆ SetClosed()

void vtkCurveRepresentation::SetClosed ( vtkTypeBool  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 vtkTypeBool vtkCurveRepresentation::GetClosed ( )
virtual

◆ ClosedOn()

virtual void vtkCurveRepresentation::ClosedOn ( )
virtual

◆ ClosedOff()

virtual void vtkCurveRepresentation::ClosedOff ( )
virtual

◆ IsClosed()

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

void vtkCurveRepresentation::BuildRepresentation ( )
overridepure 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()

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

Reimplemented from vtkWidgetRepresentation.

◆ StartWidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ EndWidgetInteraction()

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

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

double* vtkCurveRepresentation::GetBounds ( void  )
overridevirtual

Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).

in world coordinates. NULL means that the bounds are not defined.

Reimplemented from vtkProp.

◆ ReleaseGraphicsResources()

void vtkCurveRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

◆ RenderOpaqueGeometry()

int vtkCurveRepresentation::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

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

int vtkCurveRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkCurveRepresentation::RenderOverlay ( vtkViewport )
overridevirtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkCurveRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

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

◆ SetLineColor()

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

Convenience method to set the line color.

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

◆ RegisterPickers()

void vtkCurveRepresentation::RegisterPickers ( )
overridevirtual

Register internal Pickers in the Picking Manager.

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

Reimplemented from vtkWidgetRepresentation.

◆ SetCurrentHandleIndex()

void vtkCurveRepresentation::SetCurrentHandleIndex ( int  index)

Get/Set the current handle index.

Setting the current handle index will also result in the handle being highlighted. Set to -1 to remove the highlight.

◆ GetCurrentHandleIndex()

virtual int vtkCurveRepresentation::GetCurrentHandleIndex ( )
virtual

◆ GetTranslationAxis()

virtual int vtkCurveRepresentation::GetTranslationAxis ( )
virtual

Gets/Sets the constraint axis for translations.

Returns Axis::NONE if none.

◆ SetTranslationAxis()

virtual void vtkCurveRepresentation::SetTranslationAxis ( int  )
virtual

◆ SetXTranslationAxisOn()

void vtkCurveRepresentation::SetXTranslationAxisOn ( )
inline

Toggles constraint translation axis on/off.

Definition at line 267 of file vtkCurveRepresentation.h.

◆ SetYTranslationAxisOn()

void vtkCurveRepresentation::SetYTranslationAxisOn ( )
inline

Definition at line 268 of file vtkCurveRepresentation.h.

◆ SetZTranslationAxisOn()

void vtkCurveRepresentation::SetZTranslationAxisOn ( )
inline

Definition at line 269 of file vtkCurveRepresentation.h.

◆ SetTranslationAxisOff()

void vtkCurveRepresentation::SetTranslationAxisOff ( )
inline

Definition at line 270 of file vtkCurveRepresentation.h.

◆ IsTranslationConstrained()

bool vtkCurveRepresentation::IsTranslationConstrained ( )
inline

Returns true if ContrainedAxis.

Definition at line 277 of file vtkCurveRepresentation.h.

◆ 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

◆ GetHandleIndex()

int vtkCurveRepresentation::GetHandleIndex ( vtkProp prop)
protected

◆ SizeHandles()

virtual void vtkCurveRepresentation::SizeHandles ( )
protectedvirtual

◆ InsertHandleOnLine()

virtual int vtkCurveRepresentation::InsertHandleOnLine ( double *  pos)
protectedpure virtual

Returns the position of insertion or -1 on fail.

Implemented in vtkSplineRepresentation, and vtkPolyLineRepresentation.

◆ PushHandle()

virtual void vtkCurveRepresentation::PushHandle ( double *  pos)
protectedvirtual

◆ EraseHandle()

void vtkCurveRepresentation::EraseHandle ( const int &  )
protected

◆ 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 284 of file vtkCurveRepresentation.h.

◆ Bounds

double vtkCurveRepresentation::Bounds[6]
protected

Definition at line 287 of file vtkCurveRepresentation.h.

◆ ProjectionNormal

int vtkCurveRepresentation::ProjectionNormal
protected

Definition at line 290 of file vtkCurveRepresentation.h.

◆ ProjectionPosition

double vtkCurveRepresentation::ProjectionPosition
protected

Definition at line 291 of file vtkCurveRepresentation.h.

◆ ProjectToPlane

vtkTypeBool vtkCurveRepresentation::ProjectToPlane
protected

Definition at line 292 of file vtkCurveRepresentation.h.

◆ PlaneSource

vtkPlaneSource* vtkCurveRepresentation::PlaneSource
protected

Definition at line 293 of file vtkCurveRepresentation.h.

◆ NumberOfHandles

int vtkCurveRepresentation::NumberOfHandles
protected

Definition at line 300 of file vtkCurveRepresentation.h.

◆ Closed

vtkTypeBool vtkCurveRepresentation::Closed
protected

Definition at line 301 of file vtkCurveRepresentation.h.

◆ LineActor

vtkActor* vtkCurveRepresentation::LineActor
protected

Definition at line 304 of file vtkCurveRepresentation.h.

◆ Handle

vtkActor** vtkCurveRepresentation::Handle
protected

Definition at line 308 of file vtkCurveRepresentation.h.

◆ HandleGeometry

HandleSource** vtkCurveRepresentation::HandleGeometry
protected

Definition at line 309 of file vtkCurveRepresentation.h.

◆ HandlePicker

vtkCellPicker* vtkCurveRepresentation::HandlePicker
protected

Definition at line 324 of file vtkCurveRepresentation.h.

◆ LinePicker

vtkCellPicker* vtkCurveRepresentation::LinePicker
protected

Definition at line 325 of file vtkCurveRepresentation.h.

◆ LastPickPosition

double vtkCurveRepresentation::LastPickPosition[3]
protected

Definition at line 326 of file vtkCurveRepresentation.h.

◆ CurrentHandle

vtkActor* vtkCurveRepresentation::CurrentHandle
protected

Definition at line 327 of file vtkCurveRepresentation.h.

◆ CurrentHandleIndex

int vtkCurveRepresentation::CurrentHandleIndex
protected

Definition at line 328 of file vtkCurveRepresentation.h.

◆ FirstSelected

bool vtkCurveRepresentation::FirstSelected
protected

Definition at line 329 of file vtkCurveRepresentation.h.

◆ Transform

vtkTransform* vtkCurveRepresentation::Transform
protected

Definition at line 338 of file vtkCurveRepresentation.h.

◆ DirectionalLine

bool vtkCurveRepresentation::DirectionalLine
protected

Definition at line 341 of file vtkCurveRepresentation.h.

◆ HandleProperty

vtkProperty* vtkCurveRepresentation::HandleProperty
protected

Definition at line 345 of file vtkCurveRepresentation.h.

◆ SelectedHandleProperty

vtkProperty* vtkCurveRepresentation::SelectedHandleProperty
protected

Definition at line 346 of file vtkCurveRepresentation.h.

◆ LineProperty

vtkProperty* vtkCurveRepresentation::LineProperty
protected

Definition at line 347 of file vtkCurveRepresentation.h.

◆ SelectedLineProperty

vtkProperty* vtkCurveRepresentation::SelectedLineProperty
protected

Definition at line 348 of file vtkCurveRepresentation.h.

◆ Centroid

double vtkCurveRepresentation::Centroid[3]
protected

Definition at line 352 of file vtkCurveRepresentation.h.

◆ TranslationAxis

int vtkCurveRepresentation::TranslationAxis
protected

Definition at line 355 of file vtkCurveRepresentation.h.


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