ActiViz .NET  5.8.0
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private 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 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.

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.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkAnimationScene"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal IntPtr vtkAnimationScene_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkAnimationScene_AddCue_01 (HandleRef pThis, HandleRef cue)
static internal double vtkAnimationScene_GetAnimationTime_02 (HandleRef pThis)
static internal double vtkAnimationScene_GetFrameRate_03 (HandleRef pThis)
static internal int vtkAnimationScene_GetLoop_04 (HandleRef pThis)
static internal int vtkAnimationScene_GetNumberOfCues_05 (HandleRef pThis)
static internal int vtkAnimationScene_GetPlayMode_06 (HandleRef pThis)
static internal int vtkAnimationScene_IsA_07 (HandleRef pThis, string type)
static internal int vtkAnimationScene_IsInPlay_08 (HandleRef pThis)
static internal int vtkAnimationScene_IsTypeOf_09 (string type)
static internal IntPtr vtkAnimationScene_NewInstance_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkAnimationScene_Play_12 (HandleRef pThis)
static internal void vtkAnimationScene_RemoveAllCues_13 (HandleRef pThis)
static internal void vtkAnimationScene_RemoveCue_14 (HandleRef pThis, HandleRef cue)
static internal IntPtr vtkAnimationScene_SafeDownCast_15 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkAnimationScene_SetAnimationTime_16 (HandleRef pThis, double time)
static internal void vtkAnimationScene_SetFrameRate_17 (HandleRef pThis, double _arg)
static internal void vtkAnimationScene_SetLoop_18 (HandleRef pThis, int _arg)
static internal void vtkAnimationScene_SetModeToRealTime_19 (HandleRef pThis)
static internal void vtkAnimationScene_SetModeToSequence_20 (HandleRef pThis)
static internal void vtkAnimationScene_SetPlayMode_21 (HandleRef pThis, int _arg)
static internal void vtkAnimationScene_SetTimeMode_22 (HandleRef pThis, int mode)
static internal void vtkAnimationScene_Stop_23 (HandleRef pThis)

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

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.

Undocumented Block.


Member Function Documentation

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.

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.

Returns if the animation is being played.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAnimationCue.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAnimationCue.

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.

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

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAnimationCue.

Here is the call graph for this function:

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.

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.

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.

Stops the animation scene that is running.

static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_AddCue_01 ( HandleRef  pThis,
HandleRef  cue 
) [private]
static internal double Kitware.VTK.vtkAnimationScene.vtkAnimationScene_GetAnimationTime_02 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkAnimationScene.vtkAnimationScene_GetFrameRate_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAnimationScene.vtkAnimationScene_GetLoop_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAnimationScene.vtkAnimationScene_GetNumberOfCues_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAnimationScene.vtkAnimationScene_GetPlayMode_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAnimationScene.vtkAnimationScene_IsA_07 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkAnimationScene.vtkAnimationScene_IsInPlay_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkAnimationScene.vtkAnimationScene_IsTypeOf_09 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkAnimationScene.vtkAnimationScene_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkAnimationScene.vtkAnimationScene_NewInstance_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_Play_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_RemoveAllCues_13 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_RemoveCue_14 ( HandleRef  pThis,
HandleRef  cue 
) [private]
static internal IntPtr Kitware.VTK.vtkAnimationScene.vtkAnimationScene_SafeDownCast_15 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_SetAnimationTime_16 ( HandleRef  pThis,
double  time 
) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_SetFrameRate_17 ( HandleRef  pThis,
double  _arg 
) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_SetLoop_18 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_SetModeToRealTime_19 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_SetModeToSequence_20 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_SetPlayMode_21 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_SetTimeMode_22 ( HandleRef  pThis,
int  mode 
) [private]
static internal void Kitware.VTK.vtkAnimationScene.vtkAnimationScene_Stop_23 ( HandleRef  pThis) [private]

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: