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 Types inherited from vtkAnimationCue
enum  TimeCodes
 
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
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...
 
void Initialize () override
 Overridden to ignore the calls when this->Enabled == false. More...
 
void Tick (double currenttime, double deltatime, double clocktime) override
 Overridden to ignore the calls when this->Enabled == false. More...
 
void Finalize () override
 Overridden to ignore the calls when this->Enabled == false. More...
 
- Public Member Functions inherited from vtkAnimationCue
vtkAnimationCueNewInstance () const
 
virtual void SetTimeMode (int mode)
 
virtual int GetTimeMode ()
 
void SetTimeModeToRelative ()
 
void SetTimeModeToNormalized ()
 
virtual void SetStartTime (double)
 
virtual double GetStartTime ()
 
virtual void SetEndTime (double)
 
virtual double GetEndTime ()
 
virtual double GetAnimationTime ()
 
virtual double GetDeltaTime ()
 
virtual double GetClockTime ()
 
virtual void SetTimeMode (int mode)
 
virtual int GetTimeMode ()
 
void SetTimeModeToRelative ()
 
void SetTimeModeToNormalized ()
 
virtual void SetStartTime (double)
 
virtual double GetStartTime ()
 
virtual void SetEndTime (double)
 
virtual double GetEndTime ()
 
virtual double GetAnimationTime ()
 
virtual double GetDeltaTime ()
 
virtual double GetClockTime ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
- 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)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVAnimationCueSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAnimationCue
static int IsTypeOf (const char *type)
 
static vtkAnimationCueSafeDownCast (vtkObjectBase *o)
 
static vtkAnimationCueNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVAnimationCue ()
 
 ~vtkPVAnimationCue () override
 
void StartCueInternal () override
 
void TickInternal (double currenttime, double deltatime, double clocktime) override
 
void EndCueInternal () override
 
- Protected Member Functions inherited from vtkAnimationCue
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAnimationCue ()
 
 ~vtkAnimationCue ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
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

unsigned long ObserverID
 
bool UseAnimationTime
 
int AnimatedElement
 
int Enabled
 
vtkAnimationCueAnimationCue
 
vtkPVCueManipulatorManipulator
 
- Protected Attributes inherited from vtkAnimationCue
 UNINITIALIZED
 
 INACTIVE
 
 ACTIVE
 
double StartTime
 
double EndTime
 
int TimeMode
 
double AnimationTime
 
double DeltaTime
 
double ClockTime
 
int CueState
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkSMAnimationSceneProxy
 

Additional Inherited Members

- Public Attributes inherited from vtkAnimationCue
 TIMEMODE_NORMALIZED
 
 TIMEMODE_RELATIVE
 

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 26 of file vtkPVAnimationCue.h.

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkPVAnimationCue.h.

Constructor & Destructor Documentation

◆ vtkPVAnimationCue()

vtkPVAnimationCue::vtkPVAnimationCue ( )
protected

◆ ~vtkPVAnimationCue()

vtkPVAnimationCue::~vtkPVAnimationCue ( )
overrideprotected

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

◆ 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()

void vtkPVAnimationCue::Initialize ( )
overridevirtual

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

Reimplemented from vtkAnimationCue.

◆ Tick()

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

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

Reimplemented from vtkAnimationCue.

◆ Finalize()

void vtkPVAnimationCue::Finalize ( )
overridevirtual

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

Reimplemented from vtkAnimationCue.

◆ StartCueInternal()

void vtkPVAnimationCue::StartCueInternal ( )
overrideprotectedvirtual

Reimplemented from vtkAnimationCue.

◆ TickInternal()

void vtkPVAnimationCue::TickInternal ( double  currenttime,
double  deltatime,
double  clocktime 
)
overrideprotectedvirtual

Reimplemented from vtkAnimationCue.

◆ EndCueInternal()

void vtkPVAnimationCue::EndCueInternal ( )
overrideprotectedvirtual

Reimplemented from vtkAnimationCue.

Friends And Related Function Documentation

◆ vtkSMAnimationSceneProxy

friend class vtkSMAnimationSceneProxy
friend

Definition at line 102 of file vtkPVAnimationCue.h.

Member Data Documentation

◆ ObserverID

unsigned long vtkPVAnimationCue::ObserverID
protected

Definition at line 104 of file vtkPVAnimationCue.h.

◆ UseAnimationTime

bool vtkPVAnimationCue::UseAnimationTime
protected

Definition at line 105 of file vtkPVAnimationCue.h.

◆ AnimatedElement

int vtkPVAnimationCue::AnimatedElement
protected

Definition at line 106 of file vtkPVAnimationCue.h.

◆ Enabled

int vtkPVAnimationCue::Enabled
protected

Definition at line 107 of file vtkPVAnimationCue.h.

◆ AnimationCue

vtkAnimationCue* vtkPVAnimationCue::AnimationCue
protected

Definition at line 109 of file vtkPVAnimationCue.h.

◆ Manipulator

vtkPVCueManipulator* vtkPVAnimationCue::Manipulator
protected

Definition at line 110 of file vtkPVAnimationCue.h.


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