ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkPVAnimationCue Class Referenceabstract

proxy for vtkAnimationCue. More...

#include <vtkPVAnimationCue.h>

Inheritance diagram for vtkPVAnimationCue:
Inheritance graph
[legend]
Collaboration diagram for vtkPVAnimationCue:
Collaboration graph
[legend]

Public Types

typedef vtkAnimationCue Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetAnimatedElement (int)
 The index of the element of the property this cue animates. More...
 
virtual int GetAnimatedElement ()
 The index of the element of the property this cue animates. More...
 
void SetManipulator (vtkPVCueManipulator *)
 Get/Set the manipulator used to compute values for each instance in the animation. More...
 
virtual vtkPVCueManipulatorGetManipulator ()
 Get/Set the manipulator used to compute values for each instance in the animation. More...
 
virtual void SetEnabled (int)
 Enable/Disable this cue. More...
 
virtual int GetEnabled ()
 Enable/Disable this cue. More...
 
virtual void EnabledOn ()
 Enable/Disable this cue. More...
 
virtual void EnabledOff ()
 Enable/Disable this cue. More...
 
virtual void BeginUpdateAnimationValues ()=0
 Used to update the animated item. More...
 
virtual void SetAnimationValue (int index, double value)=0
 Used to update the animated item. More...
 
virtual void EndUpdateAnimationValues ()=0
 Used to update the animated item. More...
 
virtual void SetUseAnimationTime (bool)
 When set to true, the manipulator is skipped and the key frame value is set by using the ClockTime directly. More...
 
virtual bool GetUseAnimationTime ()
 When set to true, the manipulator is skipped and the key frame value is set by using the ClockTime directly. More...
 
virtual void Initialize ()
 Overridden to ignore the calls when this->Enabled == false. More...
 
virtual void Tick (double currenttime, double deltatime, double clocktime)
 Overridden to ignore the calls when this->Enabled == false. More...
 
virtual void Finalize ()
 Overridden to ignore the calls when this->Enabled == false. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVAnimationCueSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVAnimationCue ()
 
 ~vtkPVAnimationCue ()
 
virtual void StartCueInternal ()
 
virtual void TickInternal (double currenttime, double deltatime, double clocktime)
 
virtual void EndCueInternal ()
 

Protected Attributes

unsigned long ObserverID
 
bool UseAnimationTime
 
int AnimatedElement
 
int Enabled
 
vtkAnimationCue * AnimationCue
 
vtkPVCueManipulatorManipulator
 

Friends

class vtkSMAnimationSceneProxy
 

Detailed Description

proxy for vtkAnimationCue.

This is a proxy for vtkAnimationCue. All animation proxies are client side proxies. This class needs a vtkPVCueManipulator. The Manipulator performs the actual interpolation.

See also
vtkAnimationCue vtkSMAnimationSceneProxy

Definition at line 38 of file vtkPVAnimationCue.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAnimationCue vtkPVAnimationCue::Superclass

Definition at line 41 of file vtkPVAnimationCue.h.

Constructor & Destructor Documentation

◆ vtkPVAnimationCue()

vtkPVAnimationCue::vtkPVAnimationCue ( )
protected

◆ ~vtkPVAnimationCue()

vtkPVAnimationCue::~vtkPVAnimationCue ( )
protected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVAnimationCue::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkPVAnimationCue::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVAnimationCue::IsA ( const char *  type)
virtual

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetAnimatedElement()

virtual void vtkPVAnimationCue::SetAnimatedElement ( int  )
virtual

The index of the element of the property this cue animates.

If the index is -1, the cue will animate all the elements of the animated property.

◆ GetAnimatedElement()

virtual int vtkPVAnimationCue::GetAnimatedElement ( )
virtual

The index of the element of the property this cue animates.

If the index is -1, the cue will animate all the elements of the animated property.

◆ SetManipulator()

void vtkPVAnimationCue::SetManipulator ( vtkPVCueManipulator )

Get/Set the manipulator used to compute values for each instance in the animation.

Note that the time passed to the Manipulator is normalized [0,1] to the extents of this cue.

◆ GetManipulator()

virtual vtkPVCueManipulator* vtkPVAnimationCue::GetManipulator ( )
virtual

Get/Set the manipulator used to compute values for each instance in the animation.

Note that the time passed to the Manipulator is normalized [0,1] to the extents of this cue.

◆ SetEnabled()

virtual void vtkPVAnimationCue::SetEnabled ( int  )
virtual

Enable/Disable this cue.

◆ GetEnabled()

virtual int vtkPVAnimationCue::GetEnabled ( )
virtual

Enable/Disable this cue.

◆ EnabledOn()

virtual void vtkPVAnimationCue::EnabledOn ( )
virtual

Enable/Disable this cue.

◆ EnabledOff()

virtual void vtkPVAnimationCue::EnabledOff ( )
virtual

Enable/Disable this cue.

◆ BeginUpdateAnimationValues()

virtual void vtkPVAnimationCue::BeginUpdateAnimationValues ( )
pure virtual

Used to update the animated item.

This API makes it possible for vtk-level classes to update properties without actually linking with the ServerManager library. This only works since they object are created only on the client.

Implemented in vtkPVKeyFrameAnimationCueForProxies, and vtkPVCameraAnimationCue.

◆ SetAnimationValue()

virtual void vtkPVAnimationCue::SetAnimationValue ( int  index,
double  value 
)
pure virtual

Used to update the animated item.

This API makes it possible for vtk-level classes to update properties without actually linking with the ServerManager library. This only works since they object are created only on the client.

Implemented in vtkPVKeyFrameAnimationCueForProxies, and vtkPVCameraAnimationCue.

◆ EndUpdateAnimationValues()

virtual void vtkPVAnimationCue::EndUpdateAnimationValues ( )
pure virtual

Used to update the animated item.

This API makes it possible for vtk-level classes to update properties without actually linking with the ServerManager library. This only works since they object are created only on the client.

Implemented in vtkPVKeyFrameAnimationCueForProxies, and vtkPVCameraAnimationCue.

◆ SetUseAnimationTime()

virtual void vtkPVAnimationCue::SetUseAnimationTime ( bool  )
virtual

When set to true, the manipulator is skipped and the key frame value is set by using the ClockTime directly.

false by default.

◆ GetUseAnimationTime()

virtual bool vtkPVAnimationCue::GetUseAnimationTime ( )
virtual

When set to true, the manipulator is skipped and the key frame value is set by using the ClockTime directly.

false by default.

◆ Initialize()

virtual void vtkPVAnimationCue::Initialize ( )
virtual

Overridden to ignore the calls when this->Enabled == false.

◆ Tick()

virtual void vtkPVAnimationCue::Tick ( double  currenttime,
double  deltatime,
double  clocktime 
)
virtual

Overridden to ignore the calls when this->Enabled == false.

◆ Finalize()

virtual void vtkPVAnimationCue::Finalize ( )
virtual

Overridden to ignore the calls when this->Enabled == false.

◆ StartCueInternal()

virtual void vtkPVAnimationCue::StartCueInternal ( )
protectedvirtual

◆ TickInternal()

virtual void vtkPVAnimationCue::TickInternal ( double  currenttime,
double  deltatime,
double  clocktime 
)
protectedvirtual

◆ EndCueInternal()

virtual void vtkPVAnimationCue::EndCueInternal ( )
protectedvirtual

Friends And Related Function Documentation

◆ vtkSMAnimationSceneProxy

friend class vtkSMAnimationSceneProxy
friend

Definition at line 114 of file vtkPVAnimationCue.h.

Member Data Documentation

◆ ObserverID

unsigned long vtkPVAnimationCue::ObserverID
protected

Definition at line 116 of file vtkPVAnimationCue.h.

◆ UseAnimationTime

bool vtkPVAnimationCue::UseAnimationTime
protected

Definition at line 117 of file vtkPVAnimationCue.h.

◆ AnimatedElement

int vtkPVAnimationCue::AnimatedElement
protected

Definition at line 118 of file vtkPVAnimationCue.h.

◆ Enabled

int vtkPVAnimationCue::Enabled
protected

Definition at line 119 of file vtkPVAnimationCue.h.

◆ AnimationCue

vtkAnimationCue* vtkPVAnimationCue::AnimationCue
protected

Definition at line 121 of file vtkPVAnimationCue.h.

◆ Manipulator

vtkPVCueManipulator* vtkPVAnimationCue::Manipulator
protected

Definition at line 122 of file vtkPVAnimationCue.h.


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