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 | List of all members
Kitware.VTK.vtkAnimationCue Class Reference

vtkAnimationCue - a seqin an animation. More...

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

Public Types

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

 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 GetAnimationTime ()
 This is valid only in a AnimationCueTickEvent handler. Before firing the event the animation cue sets the AnimationTime to the time of the tick.
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.
override int IsA (string type)
 Undocumented Block
new vtkAnimationCue NewInstance ()
 Undocumented Block
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).
virtual void SetTimeMode (int mode)
 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 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 vtkAnimationCue New ()
 Undocumented Block
static new int IsTypeOf (string type)
 Undocumented Block
static new vtkAnimationCue SafeDownCast (vtkObjectBase o)
 Undocumented Block
- Static Public Member Functions inherited from Kitware.VTK.vtkObject
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. It allows the debugger to break on error.
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkAnimationCue"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkObject
new const string MRFullTypeName = "Kitware.VTK.vtkObject"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
new const string MRFullTypeName = "Kitware.VTK.vtkObjectBase"
 Automatically generated type registration mechanics.
- 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 = "15vtkAnimationCue"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkObject
static new readonly string MRClassNameKey = "9vtkObject"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase
static new readonly string MRClassNameKey = "13vtkObjectBase"
 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.

Static Private Member Functions

static vtkAnimationCue ()
 Automatically generated type registration mechanics.

Additional Inherited Members

- Properties inherited from Kitware.VTK.vtkObject
Kitware.VTK.vtkObject.vtkObjectEventHandler AbortCheckEvt
 The AbortCheckEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AbortCheckEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler AnimationCueTickEvt
 The AnimationCueTickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AnimationCueTickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler AnyEvt
 The AnyEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AnyEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler CharEvt
 The CharEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CharEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ConfigureEvt
 The ConfigureEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConfigureEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ConnectionClosedEvt
 The ConnectionClosedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConnectionClosedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ConnectionCreatedEvt
 The ConnectionCreatedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConnectionCreatedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler CreateTimerEvt
 The CreateTimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CreateTimerEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler CursorChangedEvt
 The CursorChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CursorChangedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DeleteEvt
 The DeleteEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DeleteEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DestroyTimerEvt
 The DestroyTimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DestroyTimerEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DisableEvt
 The DisableEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DisableEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler DomainModifiedEvt
 The DomainModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DomainModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EnableEvt
 The EnableEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EnableEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndAnimationCueEvt
 The EndAnimationCueEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndAnimationCueEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndEvt
 The EndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndInteractionEvt
 The EndInteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndInteractionEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndPickEvt
 The EndPickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndPickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EndWindowLevelEvt
 The EndWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndWindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler EnterEvt
 The EnterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EnterEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ErrorEvt
 The ErrorEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ErrorEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ExecuteInformationEvt
 The ExecuteInformationEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExecuteInformationEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ExitEvt
 The ExitEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExitEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ExposeEvt
 The ExposeEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExposeEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler InteractionEvt
 The InteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.InteractionEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler KeyPressEvt
 The KeyPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.KeyPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler KeyReleaseEvt
 The KeyReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.KeyReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler LeaveEvt
 The LeaveEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeaveEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler LeftButtonPressEvt
 The LeftButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeftButtonPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler LeftButtonReleaseEvt
 The LeftButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeftButtonReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MiddleButtonPressEvt
 The MiddleButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MiddleButtonPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MiddleButtonReleaseEvt
 The MiddleButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MiddleButtonReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ModifiedEvt
 The ModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseMoveEvt
 The MouseMoveEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseMoveEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseWheelBackwardEvt
 The MouseWheelBackwardEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseWheelBackwardEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseWheelForwardEvt
 The MouseWheelForwardEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseWheelForwardEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PickEvt
 The PickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PlacePointEvt
 The PlacePointEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PlacePointEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PlaceWidgetEvt
 The PlaceWidgetEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PlaceWidgetEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ProgressEvt
 The ProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ProgressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler PropertyModifiedEvt
 The PropertyModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PropertyModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RegisterEvt
 The RegisterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RegisterEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RenderEvt
 The RenderEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RenderEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RenderWindowMessageEvt
 The RenderWindowMessageEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RenderWindowMessageEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetCameraClippingRangeEvt
 The ResetCameraClippingRangeEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetCameraClippingRangeEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetCameraEvt
 The ResetCameraEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetCameraEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetWindowLevelEvt
 The ResetWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetWindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RightButtonPressEvt
 The RightButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RightButtonPressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler RightButtonReleaseEvt
 The RightButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RightButtonReleaseEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler SelectionChangedEvt
 The SelectionChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.SelectionChangedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler SetOutputEvt
 The SetOutputEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.SetOutputEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartAnimationCueEvt
 The StartAnimationCueEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartAnimationCueEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartEvt
 The StartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartInteractionEvt
 The StartInteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartInteractionEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartPickEvt
 The StartPickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartPickEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler StartWindowLevelEvt
 The StartWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartWindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler TimerEvt
 The TimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.TimerEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UnRegisterEvt
 The UnRegisterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UnRegisterEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdateEvt
 The UpdateEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdateEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdateInformationEvt
 The UpdateInformationEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdateInformationEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdatePropertyEvt
 The UpdatePropertyEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdatePropertyEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsEndEvt
 The VolumeMapperComputeGradientsEndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsEndEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsProgressEvt
 The VolumeMapperComputeGradientsProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsProgressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsStartEvt
 The VolumeMapperComputeGradientsStartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsStartEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderEndEvt
 The VolumeMapperRenderEndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderEndEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderProgressEvt
 The VolumeMapperRenderProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderProgressEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderStartEvt
 The VolumeMapperRenderStartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderStartEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WarningEvt
 The WarningEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WarningEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetActivateEvt
 The WidgetActivateEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetActivateEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetModifiedEvt
 The WidgetModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetModifiedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetValueChangedEvt
 The WidgetValueChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetValueChangedEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WindowLevelEvt
 The WindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WindowLevelEvent as the eventId parameter.
Kitware.VTK.vtkObject.vtkObjectEventHandler WrongTagEvt
 The WrongTagEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WrongTagEvent as the eventId parameter.

Detailed Description

vtkAnimationCue - a seqin an animation.

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 on individual cues or other scenes.

A cue has three states: UNINITIALIZED, ACTIVE and INACTIVE. UNINITIALIZED represents an point in time before the start time of the cue. The cue is in ACTIVE state at a point in time between start time and end time for the cue. While, beyond the end time, it is in INACTIVE state. When the cue enters the ACTIVE state, StartAnimationCueEvent is fired. This event may be handled to initialize the entity to be animated. When the cue leaves the ACTIVE state, EndAnimationCueEvent is fired, which can be handled to cleanup after having run the animation. For every request to render during the ACTIVE state, AnimationCueTickEvent is fired, which must be handled to perform the actual animation.

vtkAnimationScene

Member Enumeration Documentation

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.

Enumerator:
TIMEMODE_NORMALIZED 

enum member

TIMEMODE_RELATIVE 

enum member

Constructor & Destructor Documentation

static Kitware.VTK.vtkAnimationCue.vtkAnimationCue ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkAnimationCue.vtkAnimationCue ( )

Undocumented Block

Member Function Documentation

override void Kitware.VTK.vtkAnimationCue.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.vtkObject.

Reimplemented in Kitware.VTK.vtkAnimationScene.

virtual void Kitware.VTK.vtkAnimationCue.FinalizeWrapper ( )
virtual

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 Kitware.VTK.vtkAnimationCue.GetAnimationTime ( )
virtual

This is valid only in a AnimationCueTickEvent handler. Before firing the event the animation cue sets the AnimationTime to the time of the tick.

Reimplemented in Kitware.VTK.vtkAnimationScene.

virtual double Kitware.VTK.vtkAnimationCue.GetClockTime ( )
virtual

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 Kitware.VTK.vtkAnimationCue.GetDeltaTime ( )
virtual

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 Kitware.VTK.vtkAnimationCue.GetEndTime ( )
virtual

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 Kitware.VTK.vtkAnimationCue.GetStartTime ( )
virtual

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 Kitware.VTK.vtkAnimationCue.GetTimeMode ( )
virtual

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 Kitware.VTK.vtkAnimationCue.Initialize ( )
virtual

Called when the playing of the scene begins. This will set the Cue to UNINITIALIZED state.

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

Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkAnimationScene.

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

Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkAnimationScene.

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

Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkAnimationScene.

new vtkAnimationCue Kitware.VTK.vtkAnimationCue.NewInstance ( )

Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkAnimationScene.

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

Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkAnimationScene.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkAnimationCue.SetEndTime ( double  _arg)
virtual

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 Kitware.VTK.vtkAnimationCue.SetStartTime ( double  _arg)
virtual

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 void Kitware.VTK.vtkAnimationCue.SetTimeMode ( int  mode)
virtual

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.

Reimplemented in Kitware.VTK.vtkAnimationScene.

void Kitware.VTK.vtkAnimationCue.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 Kitware.VTK.vtkAnimationCue.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 Kitware.VTK.vtkAnimationCue.Tick ( double  currenttime,
double  deltatime,
double  clocktime 
)
virtual

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;

Member Data Documentation

new readonly string Kitware.VTK.vtkAnimationCue.MRClassNameKey = "15vtkAnimationCue"
static

Automatically generated type registration mechanics.

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

Automatically generated type registration mechanics.


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