VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCompositeControlPointsItem Class Reference

Control points for vtkCompositeFunction. More...

#include <vtkCompositeControlPointsItem.h>

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

Public Types

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

Public Member Functions

virtual int IsA (const char *type)
 
vtkCompositeControlPointsItemNewInstance () const
 
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
vtkColorTransferControlPointsItemNewInstance () const
 
void SetColorTransferFunction (vtkColorTransferFunction *function)
 
virtual vtkColorTransferFunction * GetColorTransferFunction ()
 
virtual void SetColorFill (bool)
 
virtual bool GetColorFill ()
 
- Public Member Functions inherited from vtkControlPointsItem
vtkControlPointsItemNewInstance () const
 
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
vtkPlotNewInstance () const
 
virtual void SetWidth (float width)
 
virtual float GetWidth ()
 
virtual void SetLabel (const vtkStdString &label)
 
virtual vtkStdString GetLabel ()
 
virtual void SetLabels (vtkStringArray *labels)
 
virtual vtkStringArrayGetLabels ()
 
virtual int GetNumberOfLabels ()
 
vtkStdString GetLabel (vtkIdType index)
 
void SetIndexedLabels (vtkStringArray *labels)
 
virtual vtkStringArrayGetIndexedLabels ()
 
vtkContextMapper2D * GetData ()
 
virtual vtkTable * GetInput ()
 
virtual void SetInputArray (int index, const vtkStdString &name)
 
virtual void SetSelection (vtkIdTypeArray *id)
 
virtual vtkIdTypeArrayGetSelection ()
 
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 vtkAxisGetXAxis ()
 
virtual void SetXAxis (vtkAxis *axis)
 
virtual vtkAxisGetYAxis ()
 
virtual void SetYAxis (vtkAxis *axis)
 
virtual void GetUnscaledInputBounds (double bounds[4])
 
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 
virtual vtkVariant GetProperty (const vtkStdString &property)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static
vtkCompositeControlPointsItem
SafeDownCast (vtkObjectBase *o)
 
static
vtkCompositeControlPointsItem
New ()
 
- Static Public Member Functions inherited from vtkColorTransferControlPointsItem
static int IsTypeOf (const char *type)
 
static
vtkColorTransferControlPointsItem
SafeDownCast (vtkObjectBase *o)
 
static
vtkColorTransferControlPointsItem
New ()
 
- Static Public Member Functions inherited from vtkControlPointsItem
static int IsTypeOf (const char *type)
 
static vtkControlPointsItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPlot
static int IsTypeOf (const char *type)
 
static vtkPlotSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 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 Attributes

int PointsFunction
 
vtkPiecewiseFunction * OpacityFunction
 
vtkPiecewisePointHandleItemOpacityPointHandle
 
bool UseOpacityPointHandles
 
- Protected Attributes inherited from vtkColorTransferControlPointsItem
vtkColorTransferFunction * ColorTransferFunction
 
bool ColorFill
 
- Protected Attributes inherited from vtkControlPointsItem
vtkCallbackCommandCallback
 
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< vtkStringArrayLabels
 
vtkSmartPointer< vtkStringArrayAutoLabels
 
vtkSmartPointer< vtkStringArrayIndexedLabels
 
bool UseIndexForXSeries
 
vtkSmartPointer
< vtkContextMapper2D > 
Data
 
vtkIdTypeArraySelection
 
vtkAxisXAxis
 
vtkAxisYAxis
 
vtkStdString TooltipLabelFormat
 
vtkStdString TooltipDefaultLabelFormat
 
int TooltipNotation
 
int TooltipPrecision
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkControlPointsItem
static void CallComputePoints (vtkObject *sender, unsigned long event, void *receiver, void *params)
 

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

Definition at line 45 of file vtkCompositeControlPointsItem.h.

Member Enumeration Documentation

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

static int vtkCompositeControlPointsItem::IsTypeOf ( const char *  type)
static
virtual int vtkCompositeControlPointsItem::IsA ( const char *  type)
virtual

Reimplemented from vtkColorTransferControlPointsItem.

static vtkCompositeControlPointsItem* vtkCompositeControlPointsItem::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkCompositeControlPointsItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkColorTransferControlPointsItem.

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

Reimplemented from vtkColorTransferControlPointsItem.

static vtkCompositeControlPointsItem* vtkCompositeControlPointsItem::New ( )
static

Creates a piecewise control points object

virtual void vtkCompositeControlPointsItem::SetColorTransferFunction ( vtkColorTransferFunction *  function)
virtual

Set the color transfer function to draw its points

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.

virtual void vtkCompositeControlPointsItem::EditPoint ( float  tX,
float  tY 
)
protectedvirtual

Reimplemented from vtkColorTransferControlPointsItem.

virtual void vtkCompositeControlPointsItem::EditPointCurve ( vtkIdType  idx)
protectedvirtual
void vtkCompositeControlPointsItem::MergeTransferFunctions ( )
protected
void vtkCompositeControlPointsItem::SilentMergeTransferFunctions ( )
protected

Member Data Documentation

int vtkCompositeControlPointsItem::PointsFunction
protected

Definition at line 122 of file vtkCompositeControlPointsItem.h.

vtkPiecewiseFunction* vtkCompositeControlPointsItem::OpacityFunction
protected

Definition at line 123 of file vtkCompositeControlPointsItem.h.

vtkPiecewisePointHandleItem* vtkCompositeControlPointsItem::OpacityPointHandle
protected

Definition at line 124 of file vtkCompositeControlPointsItem.h.

bool vtkCompositeControlPointsItem::UseOpacityPointHandles
protected

Definition at line 125 of file vtkCompositeControlPointsItem.h.


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