Control points for vtkCompositeFunction. More...

#include <vtkCompositeControlPointsItem.h>

Inheritance diagram for vtkCompositeControlPointsItem:

Collaboration diagram for vtkCompositeControlPointsItem:

Public Types
enum	PointsFunctionType { ColorPointsFunction = 1, OpacityPointsFunction = 2, ColorAndOpacityPointsFunction = 3 }
typedef vtkColorTransferControlPointsItem	Superclass
Public Types inherited from vtkColorTransferControlPointsItem
Public Types inherited from vtkControlPointsItem
enum	{ CurrentPointChangedEvent = vtkCommand::UserEvent, CurrentPointEditEvent }
Public Types inherited from vtkPlot
Public Types inherited from vtkContextItem
Public Types inherited from vtkAbstractContextItem
Public Types inherited from vtkObject

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
virtual void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetColorTransferFunction (vtkColorTransferFunction *function)
virtual vtkIdType	AddPoint (double *newPos)
virtual vtkIdType	RemovePoint (double *pos)

void	SetOpacityFunction (vtkPiecewiseFunction *opacity)
virtual vtkPiecewiseFunction *	GetOpacityFunction ()

virtual void	SetPointsFunction (int)
virtual int	GetPointsFunction ()

virtual void	SetUseOpacityPointHandles (bool)
virtual bool	GetUseOpacityPointHandles ()

virtual bool	MouseMoveEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
Public Member Functions inherited from vtkColorTransferControlPointsItem
virtual vtkColorTransferFunction *	GetColorTransferFunction ()
virtual void	SetColorFill (bool)
virtual bool	GetColorFill ()
Public Member Functions inherited from vtkControlPointsItem
virtual void	GetBounds (double bounds[4])
virtual bool	Paint (vtkContext2D *painter)
void	SelectPoint (vtkIdType pointId)
void	SelectPoint (double *currentPoint)
void	SelectAllPoints ()
void	DeselectPoint (vtkIdType pointId)
void	DeselectPoint (double *currentPoint)
void	DeselectAllPoints ()
void	ToggleSelectPoint (vtkIdType pointId)
void	ToggleSelectPoint (double *currentPoint)
virtual bool	SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
vtkIdType	GetNumberOfSelectedPoints () const
vtkIdType	FindPoint (double *pos)
bool	IsOverPoint (double *pos, vtkIdType pointId)
vtkIdType	GetControlPointId (double *pos)
vtkIdType	RemovePoint (vtkIdType pointId)
void	RemoveCurrentPoint ()
void	MovePoints (const vtkVector2f &translation, vtkIdTypeArray *pointIds)
void	MovePoints (const vtkVector2f &translation, bool dontMoveFirstAndLast=false)
void	SpreadPoints (float factor, vtkIdTypeArray *pointIds)
void	SpreadPoints (float factor, bool dontSpreadFirstAndLast=false)
vtkIdType	GetCurrentPoint () const
void	SetCurrentPoint (vtkIdType index)
void	ResetBounds ()
virtual bool	KeyPressEvent (const vtkContextKeyEvent &key)
virtual bool	KeyReleaseEvent (const vtkContextKeyEvent &key)
virtual void	SetUserBounds (double, double, double, double)
virtual void	SetUserBounds (double[4])
virtual double *	GetUserBounds ()
virtual void	GetUserBounds (double &, double &, double &, double &)
virtual void	GetUserBounds (double[4])
virtual void	SetValidBounds (double, double, double, double)
virtual void	SetValidBounds (double[4])
virtual double *	GetValidBounds ()
virtual void	GetValidBounds (double &, double &, double &, double &)
virtual void	GetValidBounds (double[4])
virtual float	GetScreenPointRadius ()
virtual void	SetScreenPointRadius (float)
void	GetControlPointsIds (vtkIdTypeArray *ids, bool excludeFirstAndLast=false) const
virtual bool	GetStrokeMode ()
virtual void	SetSwitchPointsMode (bool)
virtual bool	GetSwitchPointsMode ()
virtual void	SetEndPointsXMovable (bool)
virtual bool	GetEndPointsXMovable ()
virtual void	SetEndPointsYMovable (bool)
virtual bool	GetEndPointsYMovable ()
virtual bool	GetEndPointsMovable ()
virtual void	SetEndPointsRemovable (bool)
virtual bool	GetEndPointsRemovable ()
virtual vtkPen *	GetSelectedPointPen ()
virtual vtkBrush *	GetSelectedPointBrush ()
Public Member Functions inherited from vtkPlot
virtual void	SetWidth (float width)
virtual float	GetWidth ()
virtual void	SetLabel (const vtkStdString &label)
virtual vtkStdString	GetLabel ()
virtual void	SetLabels (vtkStringArray *labels)
virtual vtkStringArray *	GetLabels ()
virtual int	GetNumberOfLabels ()
vtkStdString	GetLabel (vtkIdType index)
void	SetIndexedLabels (vtkStringArray *labels)
virtual vtkStringArray *	GetIndexedLabels ()
vtkContextMapper2D *	GetData ()
virtual vtkTable *	GetInput ()
virtual void	SetInputArray (int index, const vtkStdString &name)
virtual void	SetSelection (vtkIdTypeArray *id)
virtual vtkIdTypeArray *	GetSelection ()
virtual bool	PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
virtual void	SetTooltipLabelFormat (const vtkStdString &label)
virtual vtkStdString	GetTooltipLabelFormat ()
virtual void	SetTooltipNotation (int notation)
virtual int	GetTooltipNotation ()
virtual void	SetTooltipPrecision (int precision)
virtual int	GetTooltipPrecision ()
virtual vtkStdString	GetTooltipLabel (const vtkVector2f &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
virtual vtkIdType	GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location)
virtual bool	SelectPointsInPolygon (const vtkContextPolygon &polygon)
virtual void	SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
virtual void	SetColor (double r, double g, double b)
virtual void	GetColor (double rgb[3])
void	GetColor (unsigned char rgb[3])
void	SetPen (vtkPen *pen)
vtkPen *	GetPen ()
void	SetBrush (vtkBrush *brush)
vtkBrush *	GetBrush ()
virtual bool	GetUseIndexForXSeries ()
virtual void	SetUseIndexForXSeries (bool)
virtual void	SetInputData (vtkTable *table)
virtual void	SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
void	SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
virtual vtkAxis *	GetXAxis ()
virtual void	SetXAxis (vtkAxis *axis)
virtual vtkAxis *	GetYAxis ()
virtual void	SetYAxis (vtkAxis *axis)
virtual void	SetProperty (const vtkStdString &property, const vtkVariant &var)
virtual vtkVariant	GetProperty (const vtkStdString &property)
Public Member Functions inherited from vtkContextItem
virtual double	GetOpacity ()
virtual void	SetOpacity (double)
Public Member Functions inherited from vtkAbstractContextItem
virtual void	Update ()
bool	PaintChildren (vtkContext2D *painter)
virtual void	ReleaseGraphicsResources ()
unsigned int	AddItem (vtkAbstractContextItem *item)
bool	RemoveItem (vtkAbstractContextItem *item)
bool	RemoveItem (unsigned int index)
vtkAbstractContextItem *	GetItem (unsigned int index)
unsigned int	GetNumberOfItems ()
void	ClearItems ()
virtual vtkAbstractContextItem *	GetPickedItem (const vtkContextMouseEvent &mouse)
virtual bool	MouseEnterEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseLeaveEvent (const vtkContextMouseEvent &mouse)
virtual bool	MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
virtual void	SetScene (vtkContextScene *scene)
virtual void	SetParent (vtkAbstractContextItem *parent)
virtual vtkVector2f	MapToParent (const vtkVector2f &point)
virtual vtkVector2f	MapFromParent (const vtkVector2f &point)
virtual vtkVector2f	MapToScene (const vtkVector2f &point)
virtual vtkVector2f	MapFromScene (const vtkVector2f &point)
vtkContextScene *	GetScene ()
vtkAbstractContextItem *	GetParent ()
virtual bool	GetVisible ()
virtual void	SetVisible (bool)
Public Member Functions inherited from vtkObject
virtual void	DebugOn ()
virtual void	DebugOff ()
unsigned char	GetDebug ()
void	SetDebug (unsigned char debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char event, vtkCommand )
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char event, vtkCommand )
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCompositeControlPointsItem *	SafeDownCast (vtkObject *o)
static vtkCompositeControlPointsItem *	New ()

Protected Member Functions
	vtkCompositeControlPointsItem ()
virtual	~vtkCompositeControlPointsItem ()
virtual void	emitEvent (unsigned long event, void *params)
virtual unsigned long int	GetControlPointsMTime ()
virtual vtkIdType	GetNumberOfPoints () const
virtual void	DrawPoint (vtkContext2D *painter, vtkIdType index)
virtual void	GetControlPoint (vtkIdType index, double *pos) const
virtual void	SetControlPoint (vtkIdType index, double *point)
virtual void	EditPoint (float tX, float tY)
virtual void	EditPointCurve (vtkIdType idx)
void	MergeTransferFunctions ()
void	SilentMergeTransferFunctions ()
Protected Member Functions inherited from vtkColorTransferControlPointsItem
	vtkColorTransferControlPointsItem ()
virtual	~vtkColorTransferControlPointsItem ()
Protected Member Functions inherited from vtkControlPointsItem
	vtkControlPointsItem ()
virtual	~vtkControlPointsItem ()
void	StartChanges ()
void	EndChanges ()
void	StartInteraction ()
void	StartInteractionIfNotStarted ()
void	Interaction ()
void	EndInteraction ()
int	GetInteractionsCount () const
virtual bool	Hit (const vtkContextMouseEvent &mouse)
void	SetCurrentPointPos (const vtkVector2f &newPos)
vtkIdType	SetPointPos (vtkIdType point, const vtkVector2f &newPos)
void	MoveCurrentPoint (const vtkVector2f &translation)
vtkIdType	MovePoint (vtkIdType point, const vtkVector2f &translation)
vtkVector2f	GetSelectionCenterOfMass () const
vtkVector2f	GetCenterOfMass (vtkIdTypeArray *pointIDs) const
void	Stroke (const vtkVector2f &newPos)
virtual void	EditPoint (float vtkNotUsed(tX), float vtkNotUsed(tY))
virtual bool	MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
void	AddPointId (vtkIdType addedPointId)
bool	IsEndPointPicked ()
bool	IsPointRemovable (vtkIdType pointId)
virtual void	ComputePoints ()
bool	ClampPos (double pos[2], double bounds[4])
bool	ClampValidPos (double pos[2])
void	DrawUnselectedPoints (vtkContext2D *painter)
void	DrawSelectedPoints (vtkContext2D *painter)
Protected Member Functions inherited from vtkPlot
	vtkPlot ()
	~vtkPlot ()
vtkStdString	GetNumber (double position, vtkAxis *axis)
Protected Member Functions inherited from vtkContextItem
	vtkContextItem ()
	~vtkContextItem ()
Protected Member Functions inherited from vtkAbstractContextItem
	vtkAbstractContextItem ()
	~vtkAbstractContextItem ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
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
int	PointsFunction
vtkPiecewiseFunction *	OpacityFunction
vtkPiecewisePointHandleItem *	OpacityPointHandle
bool	UseOpacityPointHandles
Protected Attributes inherited from vtkColorTransferControlPointsItem
vtkColorTransferFunction *	ColorTransferFunction
bool	ColorFill
Protected Attributes inherited from vtkControlPointsItem
vtkCallbackCommand *	Callback
vtkPen *	SelectedPointPen
vtkBrush *	SelectedPointBrush
int	BlockUpdates
int	StartedInteractions
vtkIdType	CurrentPoint
double	Bounds [4]
double	UserBounds [4]
double	ValidBounds [4]
vtkTransform2D *	Transform
float	ScreenPointRadius
bool	StrokeMode
bool	SwitchPointsMode
bool	MouseMoved
bool	EnforceValidFunction
vtkIdType	PointToDelete
bool	PointAboutToBeDeleted
vtkIdType	PointToToggle
bool	PointAboutToBeToggled
bool	InvertShadow
bool	EndPointsXMovable
bool	EndPointsYMovable
bool	EndPointsRemovable
Protected Attributes inherited from vtkPlot
vtkSmartPointer< vtkPen >	Pen
vtkSmartPointer< vtkBrush >	Brush
vtkSmartPointer< vtkStringArray >	Labels
vtkSmartPointer< vtkStringArray >	AutoLabels
vtkSmartPointer< vtkStringArray >	IndexedLabels
bool	UseIndexForXSeries
vtkSmartPointer < vtkContextMapper2D >	Data
vtkIdTypeArray *	Selection
vtkAxis *	XAxis
vtkAxis *	YAxis
vtkStdString	TooltipLabelFormat
vtkStdString	TooltipDefaultLabelFormat
int	TooltipNotation
int	TooltipPrecision
Protected Attributes inherited from vtkContextItem
double	Opacity
Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene *	Scene
vtkAbstractContextItem *	Parent
vtkContextScenePrivate *	Children
bool	Visible
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Control points for vtkCompositeFunction.

vtkCompositeControlPointsItem draws the control points of a vtkPiecewiseFunction and a vtkColorTransferFunction.

See also:: vtkControlPointsItem vtkColorTransferControlPointsItem vtkCompositeTransferFunctionItem vtkPiecewisePointHandleItem

Tests:: vtkCompositeControlPointsItem (Tests)

Definition at line 41 of file vtkCompositeControlPointsItem.h.

Member Typedef Documentation

typedef vtkColorTransferControlPointsItem vtkCompositeControlPointsItem::Superclass

Reimplemented from vtkColorTransferControlPointsItem.

Definition at line 45 of file vtkCompositeControlPointsItem.h.

Member Enumeration Documentation

enum vtkCompositeControlPointsItem::PointsFunctionType

Enumerator:

ColorPointsFunction
OpacityPointsFunction
ColorAndOpacityPointsFunction

Definition at line 60 of file vtkCompositeControlPointsItem.h.

Constructor & Destructor Documentation

vtkCompositeControlPointsItem::vtkCompositeControlPointsItem ( )

protected

virtual vtkCompositeControlPointsItem::~vtkCompositeControlPointsItem ( )

protectedvirtual

Member Function Documentation

virtual const char* vtkCompositeControlPointsItem::GetClassName ( )

virtual

Reimplemented from vtkColorTransferControlPointsItem.

static int vtkCompositeControlPointsItem::IsTypeOf ( const char * name )

static

Return 1 if this class type 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 vtkColorTransferControlPointsItem.

virtual int vtkCompositeControlPointsItem::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 vtkColorTransferControlPointsItem.

static vtkCompositeControlPointsItem* vtkCompositeControlPointsItem::SafeDownCast ( vtkObject * o )

static

Reimplemented from vtkColorTransferControlPointsItem.

virtual void vtkCompositeControlPointsItem::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkColorTransferControlPointsItem.

static vtkCompositeControlPointsItem* vtkCompositeControlPointsItem::New ( )

static

Creates a piecewise control points object

Reimplemented from vtkColorTransferControlPointsItem.

virtual void vtkCompositeControlPointsItem::SetColorTransferFunction ( vtkColorTransferFunction * function )

virtual

Set the color transfer function to draw its points

Reimplemented from vtkColorTransferControlPointsItem.

void vtkCompositeControlPointsItem::SetOpacityFunction ( vtkPiecewiseFunction * opacity )

Utility function that calls SetPiecewiseFunction()

virtual vtkPiecewiseFunction* vtkCompositeControlPointsItem::GetOpacityFunction ( )

virtual

Utility function that calls SetPiecewiseFunction()

virtual void vtkCompositeControlPointsItem::SetPointsFunction ( int )

virtual

PointsFunction controls wether the points represent the ColorTransferFunction, OpacityTransferFunction or both. If ColorPointsFunction, only the points of the ColorTransfer function are used. If OpacityPointsFunction, only the points of the Opacity function are used If ColorAndOpacityPointsFunction, the points of both functions are shared by both functions. ColorAndOpacityPointsFunction by default. Note: Set the mode before the functions are set. ColorPointsFunction is not fully supported.

virtual int vtkCompositeControlPointsItem::GetPointsFunction ( )

virtual

PointsFunction controls wether the points represent the ColorTransferFunction, OpacityTransferFunction or both. If ColorPointsFunction, only the points of the ColorTransfer function are used. If OpacityPointsFunction, only the points of the Opacity function are used If ColorAndOpacityPointsFunction, the points of both functions are shared by both functions. ColorAndOpacityPointsFunction by default. Note: Set the mode before the functions are set. ColorPointsFunction is not fully supported.

virtual vtkIdType vtkCompositeControlPointsItem::AddPoint ( double * newPos )

virtual

Add a point to the function. Returns the index of the point (0 based), or -1 on error. Subclasses should reimplement this function to do the actual work.

Reimplemented from vtkColorTransferControlPointsItem.

virtual vtkIdType vtkCompositeControlPointsItem::RemovePoint ( double * pos )

virtual

Remove a point of the function. Returns the index of the point (0 based), or -1 on error. Subclasses should reimplement this function to do the actual work.

Reimplemented from vtkColorTransferControlPointsItem.

virtual void vtkCompositeControlPointsItem::SetUseOpacityPointHandles ( bool )

virtual

If UseOpacityPointHandles is true, when the current point is double clicked, a vtkPiecewisePointHandleItem will show up so that the sharpness and mid point can be adjusted in the scene with those handles False by default.

virtual bool vtkCompositeControlPointsItem::GetUseOpacityPointHandles ( )

virtual

If UseOpacityPointHandles is true, when the current point is double clicked, a vtkPiecewisePointHandleItem will show up so that the sharpness and mid point can be adjusted in the scene with those handles False by default.

virtual bool vtkCompositeControlPointsItem::MouseMoveEvent ( const vtkContextMouseEvent & mouse )

virtual

Mouse move event. To take care of some special Key stroke

Reimplemented from vtkControlPointsItem.

virtual bool vtkCompositeControlPointsItem::MouseDoubleClickEvent ( const vtkContextMouseEvent & mouse )

virtual

Mouse move event. To take care of some special Key stroke

Reimplemented from vtkControlPointsItem.

virtual bool vtkCompositeControlPointsItem::MouseButtonPressEvent ( const vtkContextMouseEvent & mouse )

virtual

Mouse move event. To take care of some special Key stroke

Reimplemented from vtkControlPointsItem.

virtual void vtkCompositeControlPointsItem::emitEvent	(	unsigned long	event,
		void *	params
	)

protectedvirtual

Reimplemented from vtkColorTransferControlPointsItem.

virtual unsigned long int vtkCompositeControlPointsItem::GetControlPointsMTime ( )

protectedvirtual

Must be reimplemented by subclasses to calculate the points to draw. It's subclass responsibility to call ComputePoints() via the callback

Reimplemented from vtkColorTransferControlPointsItem.

virtual vtkIdType vtkCompositeControlPointsItem::GetNumberOfPoints ( ) const

protectedvirtual

Return the number of points in the color transfer function.

Reimplemented from vtkColorTransferControlPointsItem.

virtual void vtkCompositeControlPointsItem::DrawPoint	(	vtkContext2D *	painter,
		vtkIdType	index
	)

protectedvirtual

Internal function that paints a collection of points and optionally excludes some.

Reimplemented from vtkColorTransferControlPointsItem.

virtual void vtkCompositeControlPointsItem::GetControlPoint	(	vtkIdType	index,
		double *	point
	)		const

protectedvirtual

Returns the x and y coordinates as well as the midpoint and sharpness of the control point corresponding to the index. Note: The y (point[1]) is always 0.5

Reimplemented from vtkColorTransferControlPointsItem.

virtual void vtkCompositeControlPointsItem::SetControlPoint	(	vtkIdType	index,
		double *	point
	)

protectedvirtual

Sets the x and y coordinates as well as the midpoint and sharpness of the control point corresponding to the index. Changing the y has no effect, it will always be 0.5

Reimplemented from vtkColorTransferControlPointsItem.