vtkPVTimeLine Class Reference

#include <vtkPVTimeLine.h>

Inheritance diagram for vtkPVTimeLine:

[legend]Collaboration diagram for vtkPVTimeLine:

[legend]List of all members.

[NOHEADER]
virtual void	InvokeSelectionChangedCommand ()
double	ActiveColor [3]
double	InactiveColor [3]
Public Member Functions
	vtkTypeRevisionMacro (vtkPVTimeLine, vtkKWParameterValueFunctionEditor)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Create (vtkKWApplication *app)
virtual int	HasFunction ()
virtual int	GetFunctionSize ()
int	GetParameterBounds (double *bounds)
void	RemoveAll ()
void	GetFocus ()
void	RemoveFocus ()
int	HasFocus ()
void	SetAnimationCue (vtkPVAnimationCue *cue)
void	ForceUpdate ()
int	CanRemoveFunctionPoint (int id)
void	MoveStartToParameter (double parameter, int enable_scaling)
void	MoveEndToParameter (double parameter, int enable_scaling)
virtual void	SetActiveColor (double, double, double)
virtual void	SetActiveColor (double[3])
virtual double *	GetActiveColor ()
virtual void	GetActiveColor (double &, double &, double &)
virtual void	GetActiveColor (double[3])
virtual void	SetInactiveColor (double, double, double)
virtual void	SetInactiveColor (double[3])
virtual double *	GetInactiveColor ()
virtual void	GetInactiveColor (double &, double &, double &)
virtual void	GetInactiveColor (double[3])
void	SetTimeMarker (double time)
double	GetTimeMarker ()
virtual void	StartInteractionCallback (int x, int y)
virtual void	MovePointCallback (int x, int y, int shift)
virtual void	EndInteractionCallback (int x, int y)
virtual void	ParameterCursorStartInteractionCallback (int x)
virtual void	ParameterCursorEndInteractionCallback ()
virtual void	ParameterCursorMoveCallback (int x)
virtual vtkPVTraceHelper *	GetTraceHelper ()
Static Public Member Functions
vtkPVTimeLine *	New ()
Protected Member Functions
	vtkPVTimeLine ()
	~vtkPVTimeLine ()
virtual int	FunctionPointParameterIsLocked (int id)
virtual int	FunctionPointCanBeMovedToParameter (int id, double parameter)
virtual unsigned long	GetFunctionMTime ()
virtual int	GetFunctionPointParameter (int id, double *parameter)
virtual int	GetFunctionPointDimensionality ()
virtual int	GetFunctionPointValues (int id, double *values)
virtual int	SetFunctionPointValues (int id, const double *values)
virtual int	InterpolateFunctionPointValues (double parameter, double *values)
virtual int	AddFunctionPoint (double parameter, const double *values, int *id)
virtual int	SetFunctionPoint (int id, double parameter, const double *values)
virtual int	RemoveFunctionPoint (int id)
Protected Attributes
int	OldSelection
int	Focus
vtkPVAnimationCue *	AnimationCue
vtkPVTraceHelper *	TraceHelper

---

Detailed Description

This is the GUI for an vtkSMKeyFrameAnimationCueManipulatorProxy. It basically if a timeline. It has two modes of operation, one in which it has a proxy associated with it. And another in which it is merely a GUI element with no proxy associated with it. The latter can be used the timeline for a group of animatable elements/properties. When no proxy is associated with the timeline, it can only have two end points.

Definition at line 32 of file vtkPVTimeLine.h.

---

Constructor & Destructor Documentation

vtkPVTimeLine::vtkPVTimeLine (   )  [protected]

vtkPVTimeLine::~vtkPVTimeLine (   )  [protected]

---

Member Function Documentation

vtkPVTimeLine* vtkPVTimeLine::New (   )  [static]

Reimplemented from vtkKWWidgetWithLabel.

vtkPVTimeLine::vtkTypeRevisionMacro (  vtkPVTimeLine  , vtkKWParameterValueFunctionEditor  )

void vtkPVTimeLine::PrintSelf (  ostream &  os, vtkIndent  indent )

Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkPVTimeLine::Create (  vtkKWApplication *  app  )  [virtual]

Create the widget. Reimplemented from vtkKWParameterValueFunctionEditor.

virtual int vtkPVTimeLine::HasFunction (   )  [virtual]

Return 1 if there is a function associated to the editor. It is used, among *other* things, to disable the UI automatically if there is nothing to edit at the moment. Implements vtkKWParameterValueFunctionInterface.

virtual int vtkPVTimeLine::GetFunctionSize (   )  [virtual]

Return the number of points/elements in the function Implements vtkKWParameterValueFunctionInterface.

int vtkPVTimeLine::GetParameterBounds (  double *  bounds  )

Get the parameter bounds of this timeline ie. from what time to what time does this timeline stretch. Returns 1 on success else 0.

void vtkPVTimeLine::RemoveAll (   )

Remove all key frames.

void vtkPVTimeLine::MoveStartToParameter (  double  parameter, int  enable_scaling )

Methods to move start/end points of the timeline with/without scaling.

void vtkPVTimeLine::MoveEndToParameter (  double  parameter, int  enable_scaling )

Methods to move start/end points of the timeline with/without scaling.

void vtkPVTimeLine::GetFocus (   )

void vtkPVTimeLine::RemoveFocus (   )

virtual void vtkPVTimeLine::SetActiveColor (  double  , double  , double  )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

virtual void vtkPVTimeLine::SetActiveColor (  double  [3]  )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

virtual double* vtkPVTimeLine::GetActiveColor (   )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

virtual void vtkPVTimeLine::GetActiveColor (  double &  , double &  , double &  )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

virtual void vtkPVTimeLine::GetActiveColor (  double  [3]  )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

virtual void vtkPVTimeLine::SetInactiveColor (  double  , double  , double  )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

virtual void vtkPVTimeLine::SetInactiveColor (  double  [3]  )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

virtual double* vtkPVTimeLine::GetInactiveColor (   )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

virtual void vtkPVTimeLine::GetInactiveColor (  double &  , double &  , double &  )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

virtual void vtkPVTimeLine::GetInactiveColor (  double  [3]  )  [virtual]

Get/Set the color to be used for the timeline when it has the focus and when it doens't have the focus.

int vtkPVTimeLine::HasFocus (   )  [inline]

Definition at line 71 of file vtkPVTimeLine.h.

void vtkPVTimeLine::SetAnimationCue (  vtkPVAnimationCue *  cue  )

void vtkPVTimeLine::SetTimeMarker (  double  time  )

Set/Get the time position marker for the timeline.

double vtkPVTimeLine::GetTimeMarker (   )

Set/Get the time position marker for the timeline.

void vtkPVTimeLine::ForceUpdate (   )

Must be called if the keyframes are changed externally. This will redraw the timeline.

virtual void vtkPVTimeLine::StartInteractionCallback (  int  x, int  y )  [virtual]

Most of these callbacks are overridden only to save the trace appropriately. Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkPVTimeLine::MovePointCallback (  int  x, int  y, int  shift )  [virtual]

Most of these callbacks are overridden only to save the trace appropriately. Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkPVTimeLine::EndInteractionCallback (  int  x, int  y )  [virtual]

Most of these callbacks are overridden only to save the trace appropriately. Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkPVTimeLine::ParameterCursorStartInteractionCallback (  int  x  )  [virtual]

Most of these callbacks are overridden only to save the trace appropriately. Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkPVTimeLine::ParameterCursorEndInteractionCallback (   )  [virtual]

Most of these callbacks are overridden only to save the trace appropriately. Reimplemented from vtkKWParameterValueFunctionEditor.

virtual void vtkPVTimeLine::ParameterCursorMoveCallback (  int  x  )  [virtual]

Most of these callbacks are overridden only to save the trace appropriately. Reimplemented from vtkKWParameterValueFunctionEditor.

virtual vtkPVTraceHelper* vtkPVTimeLine::GetTraceHelper (   )  [virtual]

Get the trace helper framework.

int vtkPVTimeLine::CanRemoveFunctionPoint (  int  id  )

Indicates if the function point can be removed.

virtual int vtkPVTimeLine::FunctionPointParameterIsLocked (  int  id  )  [protected, virtual]

Is point locked, protected, removable ? Reimplemented from vtkKWParameterValueFunctionEditor.

virtual int vtkPVTimeLine::FunctionPointCanBeMovedToParameter (  int  id, double  parameter )  [protected, virtual]

Is point locked, protected, removable ? Reimplemented from vtkKWParameterValueFunctionEditor.

virtual unsigned long vtkPVTimeLine::GetFunctionMTime (   )  [protected, virtual]

Return the modification time of the function (a monotonically increasing value changing each time the function is modified) Implements vtkKWParameterValueFunctionInterface.

virtual int vtkPVTimeLine::GetFunctionPointParameter (  int  id, double *  parameter )  [protected, virtual]

Get the 'parameter' at point 'id' Ex: a scalar range, or a instant in a timeline. Return 1 on success, 0 otherwise Implements vtkKWParameterValueFunctionInterface.

virtual int vtkPVTimeLine::GetFunctionPointDimensionality (   )  [protected, virtual]

Get the dimensionality of the points in the function (Ex: 3 for a RGB point, 1 for a boolean value or an opacity value) Implements vtkKWParameterValueFunctionInterface.

virtual int vtkPVTimeLine::GetFunctionPointValues (  int  id, double *  values )  [protected, virtual]

Description: Get the 'n-tuple' value at point 'id' (where 'n' is the dimensionality of the point). Note that 'values' has to be allocated with enough room. Return 1 on success, 0 otherwise Implements vtkKWParameterValueFunctionInterface.

virtual int vtkPVTimeLine::SetFunctionPointValues (  int  id, const double *  values )  [protected, virtual]

Set the 'n-tuple' value at point 'id' (where 'n' is the dimensionality of the point). Note that the point has to exist. Return 1 on success, 0 otherwise Implements vtkKWParameterValueFunctionInterface.

virtual int vtkPVTimeLine::InterpolateFunctionPointValues (  double  parameter, double *  values )  [protected, virtual]

Interpolate and get the 'n-tuple' value at a given 'parameter' (where 'n' is the dimensionality of the point). In other words, compute the value of a point as if it was located at a given parameter over the parameter range of the function). Note that 'values' has to be allocated with enough room. The interpolation method is function dependent (linear in the vtkKWPiecewiseFunctionEditor class for example). Return 1 on success, 0 otherwise Implements vtkKWParameterValueFunctionInterface.

virtual int vtkPVTimeLine::AddFunctionPoint (  double  parameter, const double *  values, int *  id )  [protected, virtual]

Implements vtkKWParameterValueFunctionInterface.

virtual int vtkPVTimeLine::SetFunctionPoint (  int  id, double  parameter, const double *  values )  [protected, virtual]

Set the 'parameter' *and* 'n-tuple' value at point 'id' (where 'n' is the dimensionality of the point). Note that the point has to exist. It basically *moves* the point to a new location over the parameter range and change its value simultaneously. Note that doing so should really *not* change the rank/id of the point in the function, otherwise things might go wrong (untested). Basically it means that points can not be moved "over" other points, i.e. when you drag a point in the editor, you can not move it "before" or "past" its neighbors, which makes sense anyway (I guess), but make sure the constraint is enforced :) Return 1 on success, 0 otherwise Implements vtkKWParameterValueFunctionInterface.

virtual int vtkPVTimeLine::RemoveFunctionPoint (  int  id  )  [protected, virtual]

Remove a function point 'id'. Note: do not use FunctionPointCanBeRemoved() inside that function, it has been done for you already in higher-level methods. Return 1 on success, 0 otherwise Implements vtkKWParameterValueFunctionInterface.

virtual void vtkPVTimeLine::InvokeSelectionChangedCommand (   )  [protected, virtual]

Overridden to control focus. Reimplemented from vtkKWParameterValueFunctionEditor.

---

Member Data Documentation

double vtkPVTimeLine::ActiveColor[3] [protected]

Overridden to control focus. Definition at line 124 of file vtkPVTimeLine.h.

double vtkPVTimeLine::InactiveColor[3] [protected]

Overridden to control focus. Definition at line 125 of file vtkPVTimeLine.h.

int vtkPVTimeLine::OldSelection [protected]

Definition at line 128 of file vtkPVTimeLine.h.

int vtkPVTimeLine::Focus [protected]

Definition at line 129 of file vtkPVTimeLine.h.

vtkPVAnimationCue* vtkPVTimeLine::AnimationCue [protected]

Definition at line 130 of file vtkPVTimeLine.h.

vtkPVTraceHelper* vtkPVTimeLine::TraceHelper [protected]

Definition at line 131 of file vtkPVTimeLine.h.

---

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

• GUI/Client/vtkPVTimeLine.h

---