vtkContourRepresentation Class Reference

#include <vtkContourRepresentation.h>

Inheritance diagram for vtkContourRepresentation:

[legend]

Collaboration diagram for vtkContourRepresentation:

[legend]

List of all members.

Detailed Description

represent the vtkContourWidget

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

Managing contour points:: The classes vtkContourRepresentationNode, vtkContourRepresentationInternals, vtkContourRepresentationPoint manage the data structure used to represent nodes and points on a contour. A contour may contain several nodes and several more 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.

: 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 overlayed 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 intead of world positions.

See also:: vtkContourWidget

Definition at line 91 of file vtkContourRepresentation.h.


typedef vtkWidgetRepresentation	Superclass
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
static int	IsTypeOf (const char *type)
static vtkContourRepresentation *	SafeDownCast (vtkObject *o)
Public Types
enum	{ Outside = 0, Nearby }
enum	{ Inactive = 0, Translate }
Public Member Functions
virtual int	SetActiveNodeToWorldPosition (double pos[3])
virtual int	SetActiveNodeToWorldPosition (double pos[3], double orient[9])
virtual int	GetActiveNodeWorldPosition (double pos[3])
virtual int	GetActiveNodeWorldOrientation (double orient[9])
virtual int	GetActiveNodeDisplayPosition (double pos[2])
virtual int	GetNumberOfNodes ()
virtual int	GetNthNodeDisplayPosition (int n, double pos[2])
virtual int	GetNthNodeWorldPosition (int n, double pos[3])
virtual int	GetNthNodeWorldOrientation (int n, double orient[9])
virtual int	GetNthNodeSlope (int idx, double slope[3])
virtual int	GetNumberOfIntermediatePoints (int n)
virtual int	DeleteLastNode ()
virtual int	DeleteActiveNode ()
virtual int	DeleteNthNode (int n)
virtual int	AddNodeOnContour (int X, int Y)
void	SetPointPlacer (vtkPointPlacer *)
virtual vtkPointPlacer *	GetPointPlacer ()

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

virtual int	AddNodeAtDisplayPosition (double displayPos[2])
virtual int	AddNodeAtDisplayPosition (int displayPos[2])
virtual int	AddNodeAtDisplayPosition (int X, int Y)

virtual int	ActivateNode (double displayPos[2])
virtual int	ActivateNode (int displayPos[2])
virtual int	ActivateNode (int X, int Y)

virtual int	SetActiveNodeToDisplayPosition (double pos[2])
virtual int	SetActiveNodeToDisplayPosition (int pos[2])
virtual int	SetActiveNodeToDisplayPosition (int X, int Y)

virtual int	SetNthNodeDisplayPosition (int n, int X, int Y)
virtual int	SetNthNodeDisplayPosition (int n, int pos[2])
virtual int	SetNthNodeDisplayPosition (int n, double pos[2])

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

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

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

virtual void	SetPixelTolerance (int)
virtual int	GetPixelTolerance ()

virtual void	SetWorldTolerance (double)
virtual double	GetWorldTolerance ()

virtual int	GetCurrentOperation ()
virtual void	SetCurrentOperation (int)
void	SetCurrentOperationToInactive ()
void	SetCurrentOperationToTranslate ()

void	SetLineInterpolator (vtkContourLineInterpolator *)
virtual vtkContourLineInterpolator *	GetLineInterpolator ()

virtual void	BuildRepresentation ()=0
virtual int	ComputeInteractionState (int X, int Y, int modified=0)=0
virtual void	StartWidgetInteraction (double e[2])=0
virtual void	WidgetInteraction (double e[2])=0

virtual void	ReleaseGraphicsResources (vtkWindow *w)=0
virtual int	RenderOverlay (vtkViewport *viewport)=0
virtual int	RenderOpaqueGeometry (vtkViewport *viewport)=0
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport)=0
virtual int	HasTranslucentPolygonalGeometry ()=0

void	SetClosedLoop (int val)
virtual int	GetClosedLoop ()
virtual void	ClosedLoopOn ()
virtual void	ClosedLoopOff ()

virtual vtkPolyData *	GetContourRepresentationAsPolyData ()=0
Protected Member Functions
	vtkContourRepresentation ()
	~vtkContourRepresentation ()
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])
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 *)

void	GetRendererComputedDisplayPositionFromWorldPosition (double worldPos[3], double worldOrient[9], int displayPos[2])
void	GetRendererComputedDisplayPositionFromWorldPosition (double worldPos[3], double worldOrient[9], double displayPos[2])
Protected Attributes
int	PixelTolerance
double	WorldTolerance
vtkPointPlacer *	PointPlacer
vtkContourLineInterpolator *	LineInterpolator
int	ActiveNode
int	CurrentOperation
int	ClosedLoop
vtkContourRepresentationInternals *	Internal
vtkTimeStamp	ContourBuildTime
Friends
class	vtkContourWidget

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkContourRepresentation::Superclass

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

Definition at line 99 of file vtkContourRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

Outside
Nearby

Definition at line 254 of file vtkContourRepresentation.h.

anonymous enum

Enumerator:

Inactive
Translate

Definition at line 259 of file vtkContourRepresentation.h.

Constructor & Destructor Documentation

vtkContourRepresentation::vtkContourRepresentation ( ) [protected]

vtkContourRepresentation::~vtkContourRepresentation ( ) [protected]

Member Function Documentation

virtual const char* vtkContourRepresentation::GetClassName ( ) [virtual]

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

static int vtkContourRepresentation::IsTypeOf ( const char * type ) [static]

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

virtual int vtkContourRepresentation::IsA ( const char * type ) [virtual]

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

static vtkContourRepresentation* vtkContourRepresentation::SafeDownCast ( vtkObject * o ) [static]

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

void vtkContourRepresentation::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Reimplemented in vtkFocalPlaneContourRepresentation, vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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.

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.

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.

virtual int vtkContourRepresentation::GetNumberOfNodes ( ) [virtual]

Get the number of nodes.

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.

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.

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

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.

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.

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.

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.

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.

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

virtual int vtkContourRepresentation::GetNumberOfIntermediatePoints ( int n ) [virtual]

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.

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.

virtual int vtkContourRepresentation::DeleteLastNode ( ) [virtual]

Delete the last node. Returns 1 on success or 0 if there were not any nodes.

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.

virtual int vtkContourRepresentation::DeleteNthNode ( int n ) [virtual]

Delete the nth node. Return 1 on success or 0 if n is out of range.

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.

virtual void vtkContourRepresentation::SetPixelTolerance ( int ) [virtual]

The tolerance to use when calculations are performed in display coordinates

virtual int vtkContourRepresentation::GetPixelTolerance ( ) [virtual]

The tolerance to use when calculations are performed in display coordinates

virtual void vtkContourRepresentation::SetWorldTolerance ( double ) [virtual]

The tolerance to use when calculations are performed in world coordinates

virtual double vtkContourRepresentation::GetWorldTolerance ( ) [virtual]

The tolerance to use when calculations are performed in world coordinates

virtual int vtkContourRepresentation::GetCurrentOperation ( ) [virtual]

Set / get the current operation. The widget is either inactive, or it is being translated.

virtual void vtkContourRepresentation::SetCurrentOperation ( int ) [virtual]

Set / get the current operation. The widget is either inactive, or it is being translated.

void vtkContourRepresentation::SetCurrentOperationToInactive ( ) [inline]

Set / get the current operation. The widget is either inactive, or it is being translated.

Definition at line 272 of file vtkContourRepresentation.h.

void vtkContourRepresentation::SetCurrentOperationToTranslate ( ) [inline]

Set / get the current operation. The widget is either inactive, or it is being translated.

Definition at line 274 of file vtkContourRepresentation.h.

void vtkContourRepresentation::SetPointPlacer ( vtkPointPlacer * )

virtual vtkPointPlacer* vtkContourRepresentation::GetPointPlacer ( ) [virtual]

void vtkContourRepresentation::SetLineInterpolator ( vtkContourLineInterpolator * )

Set / Get the Line Interpolator. The line interpolator is responsible for generating the line segments connecting nodes.

virtual vtkContourLineInterpolator* vtkContourRepresentation::GetLineInterpolator ( ) [virtual]

Set / Get the Line Interpolator. The line interpolator is responsible for generating the line segments connecting nodes.

virtual void vtkContourRepresentation::BuildRepresentation ( ) [pure virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkWidgetRepresentation.

Implemented in vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

virtual int vtkContourRepresentation::ComputeInteractionState	(	int	X,
		int	Y,
		int	modified = `0`
	)			`[pure virtual]`

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

Implemented in vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

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

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

Implemented in vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

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

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

Implemented in vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.

virtual void vtkContourRepresentation::ReleaseGraphicsResources ( vtkWindow * w ) [pure virtual]