VTK  9.4.20241230
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkContourRepresentation Class Referenceabstract

represent the vtkContourWidget More...

#include <vtkContourRepresentation.h>

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

Public Types

enum  { Outside = 0 , Nearby }
 
enum  { Inactive = 0 , Translate , Shift , Scale }
 
- 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 int SetActiveNodeToWorldPosition (double pos[3])
 
virtual int SetActiveNodeToWorldPosition (double pos[3], double orient[9])
 
virtual int GetActiveNodeWorldPosition (double pos[3])
 Get the world position of the active node.
 
virtual int GetActiveNodeWorldOrientation (double orient[9])
 Get the world orientation of the active node.
 
virtual int GetActiveNodeDisplayPosition (double pos[2])
 Get the display position of the active node.
 
virtual int GetNumberOfNodes ()
 Get the number of nodes.
 
virtual int GetNthNodeDisplayPosition (int n, double pos[2])
 Get the nth node's display position.
 
virtual int GetNthNodeWorldPosition (int n, double pos[3])
 Get the nth node's world position.
 
virtual vtkContourRepresentationNodeGetNthNode (int n)
 Get the nth node.
 
virtual int GetNthNodeWorldOrientation (int n, double orient[9])
 Get the nth node's world orientation.
 
virtual int GetNthNodeSlope (int idx, double slope[3])
 Get the nth node's slope.
 
virtual int GetNumberOfIntermediatePoints (int n)
 
virtual int GetIntermediatePointWorldPosition (int n, int idx, double point[3])
 Get the world position of the intermediate point at index idx between nodes n and (n+1) (or n and 0 if n is the last node and the loop is closed).
 
virtual int AddIntermediatePointWorldPosition (int n, double point[3])
 Add an intermediate point between node n and n+1 (or n and 0 if n is the last node and the loop is closed).
 
virtual int AddIntermediatePointWorldPosition (int n, double point[3], vtkIdType ptId)
 Add an intermediate point between node n and n+1 (or n and 0 if n is the last node and the loop is closed).
 
virtual int DeleteLastNode ()
 Delete the last node.
 
virtual int DeleteActiveNode ()
 Delete the active node.
 
virtual int DeleteNthNode (int n)
 Delete the nth node.
 
virtual void ClearAllNodes ()
 Delete all nodes.
 
virtual int AddNodeOnContour (int X, int Y)
 Given a specific X, Y pixel location, add a new node on the contour at this location.
 
void SetPointPlacer (vtkPointPlacer *)
 
virtual vtkPointPlacerGetPointPlacer ()
 
virtual vtkPolyDataGetContourRepresentationAsPolyData ()=0
 Get the points in this contour as a vtkPolyData.
 
void GetNodePolyData (vtkPolyData *poly)
 Get the nodes and not the intermediate points in this contour as a vtkPolyData.
 
virtual void SetRebuildLocator (bool)
 
virtual int AddNodeAtWorldPosition (double x, double y, double z)
 Add a node at a specific world position.
 
virtual int AddNodeAtWorldPosition (double worldPos[3])
 Add a node at a specific world position.
 
virtual int AddNodeAtWorldPosition (double worldPos[3], double worldOrient[9])
 Add a node at a specific world position.
 
virtual int AddNodeAtDisplayPosition (double displayPos[2])
 Add a node at a specific display position.
 
virtual int AddNodeAtDisplayPosition (int displayPos[2])
 Add a node at a specific display position.
 
virtual int AddNodeAtDisplayPosition (int X, int Y)
 Add a node at a specific display position.
 
virtual int ActivateNode (double displayPos[2])
 Given a display position, activate a node.
 
virtual int ActivateNode (int displayPos[2])
 Given a display position, activate a node.
 
virtual int ActivateNode (int X, int Y)
 Given a display position, activate a node.
 
virtual int SetActiveNodeToDisplayPosition (double pos[2])
 Move the active node based on a specified display position.
 
virtual int SetActiveNodeToDisplayPosition (int pos[2])
 Move the active node based on a specified display position.
 
virtual int SetActiveNodeToDisplayPosition (int X, int Y)
 Move the active node based on a specified display position.
 
virtual int ToggleActiveNodeSelected ()
 Set/Get whether the active or nth node is selected.
 
virtual int GetActiveNodeSelected ()
 Set/Get whether the active or nth node is selected.
 
virtual int GetNthNodeSelected (int)
 Set/Get whether the active or nth node is selected.
 
virtual int SetNthNodeSelected (int)
 Set/Get whether the active or nth node is selected.
 
virtual int SetNthNodeDisplayPosition (int n, int X, int Y)
 Set the nth node's display position.
 
virtual int SetNthNodeDisplayPosition (int n, int pos[2])
 Set the nth node's display position.
 
virtual int SetNthNodeDisplayPosition (int n, double pos[2])
 Set the nth node's display position.
 
virtual int SetNthNodeWorldPosition (int n, double pos[3])
 Set the nth node's world position.
 
virtual int SetNthNodeWorldPosition (int n, double pos[3], double orient[9])
 Set the nth node's world position.
 
virtual void SetPixelTolerance (int)
 The tolerance to use when calculations are performed in display coordinates.
 
virtual int GetPixelTolerance ()
 The tolerance to use when calculations are performed in display coordinates.
 
virtual void SetWorldTolerance (double)
 The tolerance to use when calculations are performed in world coordinates.
 
virtual double GetWorldTolerance ()
 The tolerance to use when calculations are performed in world coordinates.
 
virtual int GetCurrentOperation ()
 Set / get the current operation.
 
virtual void SetCurrentOperation (int)
 Set / get the current operation.
 
void SetCurrentOperationToInactive ()
 Set / get the current operation.
 
void SetCurrentOperationToTranslate ()
 Set / get the current operation.
 
void SetCurrentOperationToShift ()
 Set / get the current operation.
 
void SetCurrentOperationToScale ()
 Set / get the current operation.
 
void SetLineInterpolator (vtkContourLineInterpolator *)
 Set / Get the Line Interpolator.
 
virtual vtkContourLineInterpolatorGetLineInterpolator ()
 Set / Get the Line Interpolator.
 
void BuildRepresentation () override=0
 These are methods that satisfy vtkWidgetRepresentation's API.
 
int ComputeInteractionState (int X, int Y, int modified=0) override=0
 These are methods that satisfy vtkWidgetRepresentation's API.
 
void StartWidgetInteraction (double e[2]) override=0
 These are methods that satisfy vtkWidgetRepresentation's API.
 
void WidgetInteraction (double e[2]) override=0
 These are methods that satisfy vtkWidgetRepresentation's API.
 
void ReleaseGraphicsResources (vtkWindow *w) override=0
 Methods required by vtkProp superclass.
 
int RenderOverlay (vtkViewport *viewport) override=0
 Methods required by vtkProp superclass.
 
int RenderOpaqueGeometry (vtkViewport *viewport) override=0
 Methods required by vtkProp superclass.
 
int RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override=0
 Methods required by vtkProp superclass.
 
vtkTypeBool HasTranslucentPolygonalGeometry () override=0
 Methods required by vtkProp superclass.
 
void SetClosedLoop (vtkTypeBool val)
 Set / Get the ClosedLoop value.
 
virtual vtkTypeBool GetClosedLoop ()
 Set / Get the ClosedLoop value.
 
virtual void ClosedLoopOn ()
 Set / Get the ClosedLoop value.
 
virtual void ClosedLoopOff ()
 Set / Get the ClosedLoop value.
 
virtual void SetShowSelectedNodes (vtkTypeBool)
 A flag to indicate whether to show the Selected nodes Default is to set it to false.
 
virtual vtkTypeBool GetShowSelectedNodes ()
 A flag to indicate whether to show the Selected nodes Default is to set it to false.
 
virtual void ShowSelectedNodesOn ()
 A flag to indicate whether to show the Selected nodes Default is to set it to false.
 
virtual void ShowSelectedNodesOff ()
 A flag to indicate whether to show the Selected nodes Default is to set it to false.
 
- 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 vtkRendererGetRenderer ()
 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).
 
vtkWidgetRepresentationNewInstance () 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.
 
vtkPropNewInstance () 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 vtkMatrix4x4GetMatrix ()
 
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 vtkAssemblyPathGetNextPath ()
 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 vtkInformationGetPropertyKeys ()
 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,.
 
vtkObjectGetConsumer (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 vtkShaderPropertyGetShaderProperty ()
 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.
 
vtkCommandGetCommand (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.
 

Protected Member Functions

 vtkContourRepresentation ()
 
 ~vtkContourRepresentation () override
 
void AddNodeAtPositionInternal (double worldPos[3], double worldOrient[9], int displayPos[2])
 
void AddNodeAtPositionInternal (double worldPos[3], double worldOrient[9], double displayPos[2])
 
void SetNthNodeWorldPositionInternal (int n, double worldPos[3], double worldOrient[9])
 
virtual void UpdateLines (int index)
 
void UpdateLine (int idx1, int idx2)
 
virtual int FindClosestPointOnContour (int X, int Y, double worldPos[3], int *idx)
 
virtual void BuildLines ()=0
 
virtual int UpdateContour ()
 
void ComputeMidpoint (double p1[3], double p2[3], double mid[3])
 
virtual void Initialize (vtkPolyData *, vtkIdList *)
 Build a contour representation from externally supplied PolyData.
 
virtual void Initialize (vtkPolyData *)
 Overloaded initialize method, that is called when the vtkIdList is nullptr to maintain backwards compatibility.
 
virtual void InitializeContour (vtkPolyData *, vtkIdList *)
 Internal implementation, delegated to another method, so that users who override the method Initialize that takes in one argument are supported.
 
void ResetLocator ()
 Deletes the previous locator if it exists and creates a new locator.
 
void BuildLocator ()
 
void GetRendererComputedDisplayPositionFromWorldPosition (double worldPos[3], double worldOrient[9], int displayPos[2])
 Given a world position and orientation, this computes the display position using the renderer of this class.
 
void GetRendererComputedDisplayPositionFromWorldPosition (double worldPos[3], double worldOrient[9], double displayPos[2])
 Given a world position and orientation, this computes the display position using the renderer of this class.
 
- 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])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong.
 
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.
 
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
virtual vtkObjectBaseNewInstanceInternal () 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

int PixelTolerance
 
double WorldTolerance
 
vtkPointPlacerPointPlacer
 
vtkContourLineInterpolatorLineInterpolator
 
int ActiveNode
 
int CurrentOperation
 
vtkTypeBool ClosedLoop
 
vtkTypeBool ShowSelectedNodes
 
vtkContourRepresentationInternalsInternal
 
vtkTimeStamp ContourBuildTime
 
vtkIncrementalOctreePointLocatorLocator
 Adding a point locator to the representation to speed up lookup of the active node when dealing with large datasets (100k+)
 
bool RebuildLocator
 
- 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
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkContourWidget
 
typedef vtkWidgetRepresentation Superclass
 Standard VTK methods.
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard VTK methods.
 
static vtkContourRepresentationSafeDownCast (vtkObjectBase *o)
 Standard VTK methods.
 
virtual vtkTypeBool IsA (const char *type)
 Standard VTK methods.
 
vtkContourRepresentationNewInstance () const
 Standard VTK methods.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard VTK methods.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard VTK methods.
 

Additional Inherited Members

- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instances of this class.
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 Standard methods for instances of this class.
 
- 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.
 
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.
 
- 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.
 
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 vtkObjectBaseNew ()
 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.
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

represent the vtkContourWidget

The vtkContourRepresentation is a superclass for various types of representations for vtkContourWidget.

Managing contour points:
The classes vtkContourRepresentationNode, vtkContourRepresentationInternals, and vtkContourRepresentationPoint manage the data structure used to represent nodes and points on a contour. A contour may contain several nodes and several additional points. Nodes are usually the result of user-clicked points on the contour. Additional points are created between nodes to generate a smooth curve using some Interpolator – see the method SetLineInterpolator.
Managing contour points:
The data structure stores both the world and display positions for every point. (This may seem like a duplication.) The default behaviour of this class is to use the WorldPosition to do all the math. Typically a point is added at a given display position. Its corresponding world position is computed using the point placer, and stored. Any query of the display position of a stored point is done via the Renderer, which computes the display position given a world position.
Managing contour points:
So why maintain the display position? Consider drawing a contour on a volume widget. You might want the contour to be located at a certain world position in the volume or you might want to be overlaid over the window like an Actor2D. The default behaviour of this class is to provide the former behaviour.
Managing contour points:
To achieve the latter behaviour, override the methods that return the display position (to return the set display position instead of computing it from the world positions) and the method BuildLines() to interpolate lines using their display positions instead of world positions.
See also
vtkContourWidget
Online Examples:

Tests:
vtkContourRepresentation (Tests)

Definition at line 129 of file vtkContourRepresentation.h.

Member Typedef Documentation

◆ Superclass

Standard VTK methods.

Definition at line 139 of file vtkContourRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
Outside 
Nearby 

Definition at line 370 of file vtkContourRepresentation.h.

◆ anonymous enum

anonymous enum
Enumerator
Inactive 
Translate 
Shift 
Scale 

Definition at line 376 of file vtkContourRepresentation.h.

Constructor & Destructor Documentation

◆ vtkContourRepresentation()

vtkContourRepresentation::vtkContourRepresentation ( )
protected

◆ ~vtkContourRepresentation()

vtkContourRepresentation::~vtkContourRepresentation ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

Standard VTK methods.

◆ IsA()

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

◆ SafeDownCast()

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

Standard VTK methods.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkContourRepresentation::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkContourRepresentation * vtkContourRepresentation::NewInstance ( ) const

Standard VTK methods.

◆ PrintSelf()

void vtkContourRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

◆ AddNodeAtWorldPosition() [1/3]

virtual int vtkContourRepresentation::AddNodeAtWorldPosition ( double  x,
double  y,
double  z 
)
virtual

Add a node at a specific world position.

Returns 0 if the node could not be added, 1 otherwise.

◆ AddNodeAtWorldPosition() [2/3]

virtual int vtkContourRepresentation::AddNodeAtWorldPosition ( double  worldPos[3])
virtual

Add a node at a specific world position.

Returns 0 if the node could not be added, 1 otherwise.

◆ AddNodeAtWorldPosition() [3/3]

virtual int vtkContourRepresentation::AddNodeAtWorldPosition ( double  worldPos[3],
double  worldOrient[9] 
)
virtual

Add a node at a specific world position.

Returns 0 if the node could not be added, 1 otherwise.

◆ AddNodeAtDisplayPosition() [1/3]

virtual int vtkContourRepresentation::AddNodeAtDisplayPosition ( double  displayPos[2])
virtual

Add a node at a specific display position.

This will be converted into a world position according to the current constraints of the point placer. Return 0 if a point could not be added, 1 otherwise.

◆ AddNodeAtDisplayPosition() [2/3]

virtual int vtkContourRepresentation::AddNodeAtDisplayPosition ( int  displayPos[2])
virtual

Add a node at a specific display position.

This will be converted into a world position according to the current constraints of the point placer. Return 0 if a point could not be added, 1 otherwise.

◆ AddNodeAtDisplayPosition() [3/3]

virtual int vtkContourRepresentation::AddNodeAtDisplayPosition ( int  X,
int  Y 
)
virtual

Add a node at a specific display position.

This will be converted into a world position according to the current constraints of the point placer. Return 0 if a point could not be added, 1 otherwise.

◆ ActivateNode() [1/3]

virtual int vtkContourRepresentation::ActivateNode ( double  displayPos[2])
virtual

Given a display position, activate a node.

The closest node within tolerance will be activated. If a node is activated, 1 will be returned, otherwise 0 will be returned.

◆ ActivateNode() [2/3]

virtual int vtkContourRepresentation::ActivateNode ( int  displayPos[2])
virtual

Given a display position, activate a node.

The closest node within tolerance will be activated. If a node is activated, 1 will be returned, otherwise 0 will be returned.

◆ ActivateNode() [3/3]

virtual int vtkContourRepresentation::ActivateNode ( int  X,
int  Y 
)
virtual

Given a display position, activate a node.

The closest node within tolerance will be activated. If a node is activated, 1 will be returned, otherwise 0 will be returned.

◆ SetActiveNodeToWorldPosition() [1/2]

virtual int vtkContourRepresentation::SetActiveNodeToWorldPosition ( double  pos[3])
virtual

◆ SetActiveNodeToWorldPosition() [2/2]

virtual int vtkContourRepresentation::SetActiveNodeToWorldPosition ( double  pos[3],
double  orient[9] 
)
virtual

◆ SetActiveNodeToDisplayPosition() [1/3]

virtual int vtkContourRepresentation::SetActiveNodeToDisplayPosition ( double  pos[2])
virtual

Move the active node based on a specified display position.

The display position will be converted into a world position. If the new position is not valid or there is no active node, a 0 will be returned. Otherwise, on success a 1 will be returned.

◆ SetActiveNodeToDisplayPosition() [2/3]

virtual int vtkContourRepresentation::SetActiveNodeToDisplayPosition ( int  pos[2])
virtual

Move the active node based on a specified display position.

The display position will be converted into a world position. If the new position is not valid or there is no active node, a 0 will be returned. Otherwise, on success a 1 will be returned.

◆ SetActiveNodeToDisplayPosition() [3/3]

virtual int vtkContourRepresentation::SetActiveNodeToDisplayPosition ( int  X,
int  Y 
)
virtual

Move the active node based on a specified display position.

The display position will be converted into a world position. If the new position is not valid or there is no active node, a 0 will be returned. Otherwise, on success a 1 will be returned.

◆ ToggleActiveNodeSelected()

virtual int vtkContourRepresentation::ToggleActiveNodeSelected ( )
virtual

Set/Get whether the active or nth node is selected.

◆ GetActiveNodeSelected()

virtual int vtkContourRepresentation::GetActiveNodeSelected ( )
virtual

Set/Get whether the active or nth node is selected.

◆ GetNthNodeSelected()

virtual int vtkContourRepresentation::GetNthNodeSelected ( int  )
virtual

Set/Get whether the active or nth node is selected.

◆ SetNthNodeSelected()

virtual int vtkContourRepresentation::SetNthNodeSelected ( int  )
virtual

Set/Get whether the active or nth node is selected.

◆ GetActiveNodeWorldPosition()

virtual int vtkContourRepresentation::GetActiveNodeWorldPosition ( double  pos[3])
virtual

Get the world position of the active node.

Will return 0 if there is no active node, or 1 otherwise.

◆ GetActiveNodeWorldOrientation()

virtual int vtkContourRepresentation::GetActiveNodeWorldOrientation ( double  orient[9])
virtual

Get the world orientation of the active node.

Will return 0 if there is no active node, or 1 otherwise.

◆ GetActiveNodeDisplayPosition()

virtual int vtkContourRepresentation::GetActiveNodeDisplayPosition ( double  pos[2])
virtual

Get the display position of the active node.

Will return 0 if there is no active node, or 1 otherwise.

◆ GetNumberOfNodes()

virtual int vtkContourRepresentation::GetNumberOfNodes ( )
virtual

Get the number of nodes.

◆ GetNthNodeDisplayPosition()

virtual int vtkContourRepresentation::GetNthNodeDisplayPosition ( int  n,
double  pos[2] 
)
virtual

Get the nth node's display position.

Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting).

Reimplemented in vtkFocalPlaneContourRepresentation.

◆ GetNthNodeWorldPosition()

virtual int vtkContourRepresentation::GetNthNodeWorldPosition ( int  n,
double  pos[3] 
)
virtual

Get the nth node's world position.

Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting).

Reimplemented in vtkFocalPlaneContourRepresentation.

◆ GetNthNode()

virtual vtkContourRepresentationNode * vtkContourRepresentation::GetNthNode ( int  n)
virtual

Get the nth node.

◆ GetNthNodeWorldOrientation()

virtual int vtkContourRepresentation::GetNthNodeWorldOrientation ( int  n,
double  orient[9] 
)
virtual

Get the nth node's world orientation.

Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting).

◆ SetNthNodeDisplayPosition() [1/3]

virtual int vtkContourRepresentation::SetNthNodeDisplayPosition ( int  n,
int  X,
int  Y 
)
virtual

Set the nth node's display position.

Display position will be converted into world position according to the constraints of the point placer. Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting) or the world position is not valid.

◆ SetNthNodeDisplayPosition() [2/3]

virtual int vtkContourRepresentation::SetNthNodeDisplayPosition ( int  n,
int  pos[2] 
)
virtual

Set the nth node's display position.

Display position will be converted into world position according to the constraints of the point placer. Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting) or the world position is not valid.

◆ SetNthNodeDisplayPosition() [3/3]

virtual int vtkContourRepresentation::SetNthNodeDisplayPosition ( int  n,
double  pos[2] 
)
virtual

Set the nth node's display position.

Display position will be converted into world position according to the constraints of the point placer. Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting) or the world position is not valid.

◆ SetNthNodeWorldPosition() [1/2]

virtual int vtkContourRepresentation::SetNthNodeWorldPosition ( int  n,
double  pos[3] 
)
virtual

Set the nth node's world position.

Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting) or the world position is not valid according to the point placer.

◆ SetNthNodeWorldPosition() [2/2]

virtual int vtkContourRepresentation::SetNthNodeWorldPosition ( int  n,
double  pos[3],
double  orient[9] 
)
virtual

Set the nth node's world position.

Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting) or the world position is not valid according to the point placer.

◆ GetNthNodeSlope()

virtual int vtkContourRepresentation::GetNthNodeSlope ( int  idx,
double  slope[3] 
)
virtual

Get the nth node's slope.

Will return 1 on success, or 0 if there are not at least (n+1) nodes (0 based counting).

◆ GetNumberOfIntermediatePoints()

virtual int vtkContourRepresentation::GetNumberOfIntermediatePoints ( int  n)
virtual

◆ GetIntermediatePointWorldPosition()

virtual int vtkContourRepresentation::GetIntermediatePointWorldPosition ( int  n,
int  idx,
double  point[3] 
)
virtual

Get the world position of the intermediate point at index idx between nodes n and (n+1) (or n and 0 if n is the last node and the loop is closed).

Returns 1 on success or 0 if n or idx are out of range.

Reimplemented in vtkFocalPlaneContourRepresentation.

◆ AddIntermediatePointWorldPosition() [1/2]

virtual int vtkContourRepresentation::AddIntermediatePointWorldPosition ( int  n,
double  point[3] 
)
virtual

Add an intermediate point between node n and n+1 (or n and 0 if n is the last node and the loop is closed).

Returns 1 on success or 0 if n is out of range.

◆ AddIntermediatePointWorldPosition() [2/2]

virtual int vtkContourRepresentation::AddIntermediatePointWorldPosition ( int  n,
double  point[3],
vtkIdType  ptId 
)
virtual

Add an intermediate point between node n and n+1 (or n and 0 if n is the last node and the loop is closed).

Returns 1 on success or 0 if n is out of range. The added point is assigned a ptId as supplied.

◆ DeleteLastNode()

virtual int vtkContourRepresentation::DeleteLastNode ( )
virtual

Delete the last node.

Returns 1 on success or 0 if there were not any nodes.

◆ DeleteActiveNode()

virtual int vtkContourRepresentation::DeleteActiveNode ( )
virtual

Delete the active node.

Returns 1 on success or 0 if the active node did not indicate a valid node.

◆ DeleteNthNode()

virtual int vtkContourRepresentation::DeleteNthNode ( int  n)
virtual

Delete the nth node.

Return 1 on success or 0 if n is out of range.

◆ ClearAllNodes()

virtual void vtkContourRepresentation::ClearAllNodes ( )
virtual

Delete all nodes.

◆ AddNodeOnContour()

virtual int vtkContourRepresentation::AddNodeOnContour ( int  X,
int  Y 
)
virtual

Given a specific X, Y pixel location, add a new node on the contour at this location.

◆ SetPixelTolerance()

virtual void vtkContourRepresentation::SetPixelTolerance ( int  )
virtual

The tolerance to use when calculations are performed in display coordinates.

◆ GetPixelTolerance()

virtual int vtkContourRepresentation::GetPixelTolerance ( )
virtual

The tolerance to use when calculations are performed in display coordinates.

◆ SetWorldTolerance()

virtual void vtkContourRepresentation::SetWorldTolerance ( double  )
virtual

The tolerance to use when calculations are performed in world coordinates.

◆ GetWorldTolerance()

virtual double vtkContourRepresentation::GetWorldTolerance ( )
virtual

The tolerance to use when calculations are performed in world coordinates.

◆ GetCurrentOperation()

virtual int vtkContourRepresentation::GetCurrentOperation ( )
virtual

Set / get the current operation.

The widget is either inactive, or it is being translated.

◆ SetCurrentOperation()

virtual void vtkContourRepresentation::SetCurrentOperation ( int  )
virtual

Set / get the current operation.

The widget is either inactive, or it is being translated.

◆ SetCurrentOperationToInactive()

void vtkContourRepresentation::SetCurrentOperationToInactive ( )
inline

Set / get the current operation.

The widget is either inactive, or it is being translated.

Definition at line 392 of file vtkContourRepresentation.h.

◆ SetCurrentOperationToTranslate()

void vtkContourRepresentation::SetCurrentOperationToTranslate ( )
inline

Set / get the current operation.

The widget is either inactive, or it is being translated.

Definition at line 396 of file vtkContourRepresentation.h.

◆ SetCurrentOperationToShift()

void vtkContourRepresentation::SetCurrentOperationToShift ( )
inline

Set / get the current operation.

The widget is either inactive, or it is being translated.

Definition at line 400 of file vtkContourRepresentation.h.

◆ SetCurrentOperationToScale()

void vtkContourRepresentation::SetCurrentOperationToScale ( )
inline

Set / get the current operation.

The widget is either inactive, or it is being translated.

Definition at line 401 of file vtkContourRepresentation.h.

◆ SetPointPlacer()

void vtkContourRepresentation::SetPointPlacer ( vtkPointPlacer )

◆ GetPointPlacer()

virtual vtkPointPlacer * vtkContourRepresentation::GetPointPlacer ( )
virtual

◆ SetLineInterpolator()

void vtkContourRepresentation::SetLineInterpolator ( vtkContourLineInterpolator )

Set / Get the Line Interpolator.

The line interpolator is responsible for generating the line segments connecting nodes.

◆ GetLineInterpolator()

virtual vtkContourLineInterpolator * vtkContourRepresentation::GetLineInterpolator ( )
virtual

Set / Get the Line Interpolator.

The line interpolator is responsible for generating the line segments connecting nodes.

◆ BuildRepresentation()

void vtkContourRepresentation::BuildRepresentation ( )
overridepure virtual

◆ ComputeInteractionState()

int vtkContourRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modified = 0 
)
overridepure virtual

◆ StartWidgetInteraction()

void vtkContourRepresentation::StartWidgetInteraction ( double  e[2])
overridepure virtual

◆ WidgetInteraction()

void vtkContourRepresentation::WidgetInteraction ( double  e[2])
overridepure virtual

◆ ReleaseGraphicsResources()

void vtkContourRepresentation::ReleaseGraphicsResources ( vtkWindow w)
overridepure virtual

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

Implemented in vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

◆ RenderOverlay()

int vtkContourRepresentation::RenderOverlay ( vtkViewport viewport)
overridepure virtual

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

Implemented in vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

◆ RenderOpaqueGeometry()

int vtkContourRepresentation::RenderOpaqueGeometry ( vtkViewport viewport)
overridepure virtual

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

Implemented in vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

◆ RenderTranslucentPolygonalGeometry()

int vtkContourRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport viewport)
overridepure virtual

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

Implemented in vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkContourRepresentation::HasTranslucentPolygonalGeometry ( )
overridepure virtual

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

Implemented in vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

◆ SetClosedLoop()

void vtkContourRepresentation::SetClosedLoop ( vtkTypeBool  val)

Set / Get the ClosedLoop value.

This ivar indicates whether the contour forms a closed loop.

◆ GetClosedLoop()

virtual vtkTypeBool vtkContourRepresentation::GetClosedLoop ( )
virtual

Set / Get the ClosedLoop value.

This ivar indicates whether the contour forms a closed loop.

◆ ClosedLoopOn()

virtual void vtkContourRepresentation::ClosedLoopOn ( )
virtual

Set / Get the ClosedLoop value.

This ivar indicates whether the contour forms a closed loop.

◆ ClosedLoopOff()

virtual void vtkContourRepresentation::ClosedLoopOff ( )
virtual

Set / Get the ClosedLoop value.

This ivar indicates whether the contour forms a closed loop.

◆ SetShowSelectedNodes()

virtual void vtkContourRepresentation::SetShowSelectedNodes ( vtkTypeBool  )
virtual

A flag to indicate whether to show the Selected nodes Default is to set it to false.

Reimplemented in vtkOrientedGlyphContourRepresentation.

◆ GetShowSelectedNodes()

virtual vtkTypeBool vtkContourRepresentation::GetShowSelectedNodes ( )
virtual

A flag to indicate whether to show the Selected nodes Default is to set it to false.

◆ ShowSelectedNodesOn()

virtual void vtkContourRepresentation::ShowSelectedNodesOn ( )
virtual

A flag to indicate whether to show the Selected nodes Default is to set it to false.

◆ ShowSelectedNodesOff()

virtual void vtkContourRepresentation::ShowSelectedNodesOff ( )
virtual

A flag to indicate whether to show the Selected nodes Default is to set it to false.

◆ GetContourRepresentationAsPolyData()

virtual vtkPolyData * vtkContourRepresentation::GetContourRepresentationAsPolyData ( )
pure virtual

◆ GetNodePolyData()

void vtkContourRepresentation::GetNodePolyData ( vtkPolyData poly)

Get the nodes and not the intermediate points in this contour as a vtkPolyData.

◆ SetRebuildLocator()

virtual void vtkContourRepresentation::SetRebuildLocator ( bool  )
virtual

◆ AddNodeAtPositionInternal() [1/2]

void vtkContourRepresentation::AddNodeAtPositionInternal ( double  worldPos[3],
double  worldOrient[9],
int  displayPos[2] 
)
protected

◆ AddNodeAtPositionInternal() [2/2]

void vtkContourRepresentation::AddNodeAtPositionInternal ( double  worldPos[3],
double  worldOrient[9],
double  displayPos[2] 
)
protected

◆ SetNthNodeWorldPositionInternal()

void vtkContourRepresentation::SetNthNodeWorldPositionInternal ( int  n,
double  worldPos[3],
double  worldOrient[9] 
)
protected

◆ GetRendererComputedDisplayPositionFromWorldPosition() [1/2]

void vtkContourRepresentation::GetRendererComputedDisplayPositionFromWorldPosition ( double  worldPos[3],
double  worldOrient[9],
int  displayPos[2] 
)
protected

Given a world position and orientation, this computes the display position using the renderer of this class.

◆ GetRendererComputedDisplayPositionFromWorldPosition() [2/2]

void vtkContourRepresentation::GetRendererComputedDisplayPositionFromWorldPosition ( double  worldPos[3],
double  worldOrient[9],
double  displayPos[2] 
)
protected

Given a world position and orientation, this computes the display position using the renderer of this class.

◆ UpdateLines()

virtual void vtkContourRepresentation::UpdateLines ( int  index)
protectedvirtual

◆ UpdateLine()

void vtkContourRepresentation::UpdateLine ( int  idx1,
int  idx2 
)
protected

◆ FindClosestPointOnContour()

virtual int vtkContourRepresentation::FindClosestPointOnContour ( int  X,
int  Y,
double  worldPos[3],
int *  idx 
)
protectedvirtual

◆ BuildLines()

virtual void vtkContourRepresentation::BuildLines ( )
protectedpure virtual

◆ UpdateContour()

virtual int vtkContourRepresentation::UpdateContour ( )
protectedvirtual

◆ ComputeMidpoint()

void vtkContourRepresentation::ComputeMidpoint ( double  p1[3],
double  p2[3],
double  mid[3] 
)
inlineprotected

Definition at line 525 of file vtkContourRepresentation.h.

◆ Initialize() [1/2]

virtual void vtkContourRepresentation::Initialize ( vtkPolyData ,
vtkIdList  
)
protectedvirtual

Build a contour representation from externally supplied PolyData.

This is very useful when you use an external program to compute a set of contour nodes (let's say based on image features) and subsequently want to build and display a contour that runs through those points. This method is protected and accessible only from vtkContourWidget::Initialize. The idlist here may be used to initialize a contour widget that uses a vtkPolygonalSurfacePointPlacer. This stores the point id's of the nodes, since the contour is drawn on the vertices of a surface mesh.

◆ Initialize() [2/2]

virtual void vtkContourRepresentation::Initialize ( vtkPolyData )
protectedvirtual

Overloaded initialize method, that is called when the vtkIdList is nullptr to maintain backwards compatibility.

◆ InitializeContour()

virtual void vtkContourRepresentation::InitializeContour ( vtkPolyData ,
vtkIdList  
)
protectedvirtual

Internal implementation, delegated to another method, so that users who override the method Initialize that takes in one argument are supported.

◆ ResetLocator()

void vtkContourRepresentation::ResetLocator ( )
protected

Deletes the previous locator if it exists and creates a new locator.

Also deletes / recreates the attached data set.

◆ BuildLocator()

void vtkContourRepresentation::BuildLocator ( )
protected

Friends And Related Symbol Documentation

◆ vtkContourWidget

friend class vtkContourWidget
friend

Definition at line 132 of file vtkContourRepresentation.h.

Member Data Documentation

◆ PixelTolerance

int vtkContourRepresentation::PixelTolerance
protected

Definition at line 481 of file vtkContourRepresentation.h.

◆ WorldTolerance

double vtkContourRepresentation::WorldTolerance
protected

Definition at line 482 of file vtkContourRepresentation.h.

◆ PointPlacer

vtkPointPlacer* vtkContourRepresentation::PointPlacer
protected

Definition at line 484 of file vtkContourRepresentation.h.

◆ LineInterpolator

vtkContourLineInterpolator* vtkContourRepresentation::LineInterpolator
protected

Definition at line 485 of file vtkContourRepresentation.h.

◆ ActiveNode

int vtkContourRepresentation::ActiveNode
protected

Definition at line 487 of file vtkContourRepresentation.h.

◆ CurrentOperation

int vtkContourRepresentation::CurrentOperation
protected

Definition at line 489 of file vtkContourRepresentation.h.

◆ ClosedLoop

vtkTypeBool vtkContourRepresentation::ClosedLoop
protected

Definition at line 490 of file vtkContourRepresentation.h.

◆ ShowSelectedNodes

vtkTypeBool vtkContourRepresentation::ShowSelectedNodes
protected

Definition at line 493 of file vtkContourRepresentation.h.

◆ Internal

vtkContourRepresentationInternals* vtkContourRepresentation::Internal
protected

Definition at line 495 of file vtkContourRepresentation.h.

◆ ContourBuildTime

vtkTimeStamp vtkContourRepresentation::ContourBuildTime
protected

Definition at line 523 of file vtkContourRepresentation.h.

◆ Locator

vtkIncrementalOctreePointLocator* vtkContourRepresentation::Locator
protected

Adding a point locator to the representation to speed up lookup of the active node when dealing with large datasets (100k+)

Definition at line 561 of file vtkContourRepresentation.h.

◆ RebuildLocator

bool vtkContourRepresentation::RebuildLocator
protected

Definition at line 571 of file vtkContourRepresentation.h.


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