ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions
Kitware.VTK.vtkAnimationScene Class Reference

vtkAnimationScene - the animation scene manager. More...

Inheritance diagram for Kitware.VTK.vtkAnimationScene:
[legend]
Collaboration diagram for Kitware.VTK.vtkAnimationScene:
[legend]

List of all members.

Public Types

enum  PlayModes { PLAYMODE_REALTIME = 1, PLAYMODE_SEQUENCE = 0 }
 Returns if the animation is being played. More...
- Public Types inherited from Kitware.VTK.vtkAnimationCue
enum  TimeCodes { TIMEMODE_NORMALIZED = 0, TIMEMODE_RELATIVE = 1 }
 This is valid only in a AnimationCueTickEvent handler. Before firing the event the animation cue sets the ClockTime to the time of the tick. ClockTime is directly the time from the animation scene neither normalized nor offsetted to the start of the scene. More...

Public Member Functions

 vtkAnimationScene (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkAnimationScene ()
 *Undocumented Block
void AddCue (vtkAnimationCue cue)
 Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.
override double GetAnimationTime ()
 Makes the state of the scene same as the given time.
virtual double GetFrameRate ()
 Get/Set the frame rate (in frames per second). This parameter affects only in the Sequence mode. The time interval indicated to each cue on every tick is progressed by 1/frame-rate seconds.
virtual int GetLoop ()
 Enable/Disable animation loop.
int GetNumberOfCues ()
 Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.
virtual int GetPlayMode ()
 Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.
override int IsA (string type)
 *Undocumented Block
int IsInPlay ()
 Returns if the animation is being played.
new vtkAnimationScene NewInstance ()
 *Undocumented Block
virtual void Play ()
 Starts playing the animation scene. Fires a vtkCommand::StartEvent before play beings and vtkCommand::EndEvent after play ends.
void RemoveAllCues ()
 Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.
void RemoveCue (vtkAnimationCue cue)
 Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.
void SetAnimationTime (double time)
 Makes the state of the scene same as the given time.
virtual void SetFrameRate (double _arg)
 Get/Set the frame rate (in frames per second). This parameter affects only in the Sequence mode. The time interval indicated to each cue on every tick is progressed by 1/frame-rate seconds.
virtual void SetLoop (int _arg)
 Enable/Disable animation loop.
void SetModeToRealTime ()
 Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.
void SetModeToSequence ()
 Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.
virtual void SetPlayMode (int _arg)
 Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.
override void SetTimeMode (int mode)
 Overridden to allow change to Normalized mode only if none of the constituent cues is in Relative time mode.
void Stop ()
 Stops the animation scene that is running.
- Public Member Functions inherited from Kitware.VTK.vtkAnimationCue
 vtkAnimationCue (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkAnimationCue ()
 *Undocumented Block
virtual void FinalizeWrapper ()
 Called when the scene reaches the end. If the cue state is ACTIVE when this method is called, this will trigger a EndAnimationCueEvent.
virtual double GetClockTime ()
 This is valid only in a AnimationCueTickEvent handler. Before firing the event the animation cue sets the ClockTime to the time of the tick. ClockTime is directly the time from the animation scene neither normalized nor offsetted to the start of the scene.
virtual double GetDeltaTime ()
 This is valid only in a AnimationCueTickEvent handler. Before firing the event the animation cue sets the DeltaTime to the difference in time between the current tick and the last tick.
virtual double GetEndTime ()
 Get/Set the End time for this cue. When the current time is > EndTime, the Cue is in INACTIVE state. Whenever the cue leaves an ACTIVE state to enter INACTIVE state, the EndEvent is triggered. The End time is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode).
virtual double GetStartTime ()
 Get/Set the Start time for this cue. When the current time is >= StartTime, the Cue is in ACTIVE state. if Current time i < StartTime, the Cue is in UNINITIALIZED state. Whenever the cue enters the ACTIVE state from an INACTIVE state, it triggers the StartEvent. The Start time is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode).
virtual int GetTimeMode ()
 Get/Set the time mode. In Normalized mode, the start and end times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the container scene.
virtual void Initialize ()
 Called when the playing of the scene begins. This will set the Cue to UNINITIALIZED state.
virtual void SetEndTime (double _arg)
 Get/Set the End time for this cue. When the current time is > EndTime, the Cue is in INACTIVE state. Whenever the cue leaves an ACTIVE state to enter INACTIVE state, the EndEvent is triggered. The End time is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode).
virtual void SetStartTime (double _arg)
 Get/Set the Start time for this cue. When the current time is >= StartTime, the Cue is in ACTIVE state. if Current time i < StartTime, the Cue is in UNINITIALIZED state. Whenever the cue enters the ACTIVE state from an INACTIVE state, it triggers the StartEvent. The Start time is in seconds relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode).
void SetTimeModeToNormalized ()
 Get/Set the time mode. In Normalized mode, the start and end times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the container scene.
void SetTimeModeToRelative ()
 Get/Set the time mode. In Normalized mode, the start and end times of the cue are normalized [0,1] with respect to the start and end times of the container scene. In Relative mode the start and end time of the cue are specified in offset seconds relative to the start time of the container scene.
virtual void Tick (double currenttime, double deltatime, double clocktime)
 Indicates a tick or point in time in the animation. Triggers a Tick event if currenttime >= StartTime and currenttime <= EndTime. Whenever the state of the cue changes, either StartEvent or EndEvent is triggerred depending upon whether the cue entered Active state or quit active state respectively. The current time is relative to the start of the container Scene (when in Relative time mode) or is normalized over the span of the container Scene (when in Normalized time mode). deltatime is the time since last call to Tick. deltatime also can be in seconds relative to the start of the container Scene or normalized depending upon the cue's Time mode. clocktime is the time from the scene i.e. it does not depend on the time mode for the cue. For the first call to Tick after a call to Initialize(), the deltatime is 0;.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new vtkAnimationScene New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkAnimationScene SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkAnimationScene"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkAnimationCue
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkAnimationScene"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkAnimationCue
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions

static vtkAnimationScene ()
 Automatically generated type registration mechanics.

Detailed Description

vtkAnimationScene - the animation scene manager.

Description vtkAnimationCue and vtkAnimationScene provide the framework to support animations in VTK. vtkAnimationCue represents an entity that changes/ animates with time, while vtkAnimationScene represents scene or setup for the animation, which consists of individual cues or other scenes.

A scene can be played in real time mode, or as a seqence of frames 1/frame rate apart in time.

vtkAnimationCue


Member Enumeration Documentation

Returns if the animation is being played.

Enumerator:
PLAYMODE_REALTIME 

enum member

PLAYMODE_SEQUENCE 

enum member


Constructor & Destructor Documentation

static Kitware.VTK.vtkAnimationScene.vtkAnimationScene ( )
staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkAnimationScene.vtkAnimationScene ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkAnimationScene.vtkAnimationScene ( )

*Undocumented Block


Member Function Documentation

void Kitware.VTK.vtkAnimationScene.AddCue ( vtkAnimationCue  cue)

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

override void Kitware.VTK.vtkAnimationScene.Dispose ( bool  disposing)
protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkAnimationCue.

override double Kitware.VTK.vtkAnimationScene.GetAnimationTime ( )
virtual

Makes the state of the scene same as the given time.

Reimplemented from Kitware.VTK.vtkAnimationCue.

virtual double Kitware.VTK.vtkAnimationScene.GetFrameRate ( )
virtual

Get/Set the frame rate (in frames per second). This parameter affects only in the Sequence mode. The time interval indicated to each cue on every tick is progressed by 1/frame-rate seconds.

virtual int Kitware.VTK.vtkAnimationScene.GetLoop ( )
virtual

Enable/Disable animation loop.

int Kitware.VTK.vtkAnimationScene.GetNumberOfCues ( )

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

virtual int Kitware.VTK.vtkAnimationScene.GetPlayMode ( )
virtual

Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.

override int Kitware.VTK.vtkAnimationScene.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAnimationCue.

int Kitware.VTK.vtkAnimationScene.IsInPlay ( )

Returns if the animation is being played.

static new int Kitware.VTK.vtkAnimationScene.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAnimationCue.

static new vtkAnimationScene Kitware.VTK.vtkAnimationScene.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAnimationCue.

new vtkAnimationScene Kitware.VTK.vtkAnimationScene.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAnimationCue.

virtual void Kitware.VTK.vtkAnimationScene.Play ( )
virtual

Starts playing the animation scene. Fires a vtkCommand::StartEvent before play beings and vtkCommand::EndEvent after play ends.

void Kitware.VTK.vtkAnimationScene.RemoveAllCues ( )

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

void Kitware.VTK.vtkAnimationScene.RemoveCue ( vtkAnimationCue  cue)

Add/Remove an AnimationCue to/from the Scene. It's an error to add a cue twice to the Scene.

static new vtkAnimationScene Kitware.VTK.vtkAnimationScene.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkAnimationCue.

Here is the call graph for this function:

void Kitware.VTK.vtkAnimationScene.SetAnimationTime ( double  time)

Makes the state of the scene same as the given time.

virtual void Kitware.VTK.vtkAnimationScene.SetFrameRate ( double  _arg)
virtual

Get/Set the frame rate (in frames per second). This parameter affects only in the Sequence mode. The time interval indicated to each cue on every tick is progressed by 1/frame-rate seconds.

virtual void Kitware.VTK.vtkAnimationScene.SetLoop ( int  _arg)
virtual

Enable/Disable animation loop.

void Kitware.VTK.vtkAnimationScene.SetModeToRealTime ( )

Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.

void Kitware.VTK.vtkAnimationScene.SetModeToSequence ( )

Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.

virtual void Kitware.VTK.vtkAnimationScene.SetPlayMode ( int  _arg)
virtual

Get/Set the PlayMode for running/playing the animation scene. In the Sequence mode, all the frames are generated one after the other. The time reported to each Tick of the constituent cues (during Play) is incremented by 1/frame rate, irrespective of the current time. In the RealTime mode, time indicates the instance in time.

override void Kitware.VTK.vtkAnimationScene.SetTimeMode ( int  mode)
virtual

Overridden to allow change to Normalized mode only if none of the constituent cues is in Relative time mode.

Reimplemented from Kitware.VTK.vtkAnimationCue.

void Kitware.VTK.vtkAnimationScene.Stop ( )

Stops the animation scene that is running.


Member Data Documentation

new readonly string Kitware.VTK.vtkAnimationScene.MRClassNameKey = "17vtkAnimationScene"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAnimationCue.

new const string Kitware.VTK.vtkAnimationScene.MRFullTypeName = "Kitware.VTK.vtkAnimationScene"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkAnimationCue.


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