ActiViz .NET
5.8.0
|
vtkAnimationCue - a seqin an animation. More...
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;. | |
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. | |
Public Attributes | |
new const string | MRFullTypeName = "Kitware.VTK.vtkAnimationCue" |
Automatically generated type registration mechanics. | |
Static Public Attributes | |
static new readonly string | MRClassNameKey = "15vtkAnimationCue" |
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 | vtkAnimationCue_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal void | vtkAnimationCue_Finalize_01 (HandleRef pThis) |
static internal double | vtkAnimationCue_GetAnimationTime_02 (HandleRef pThis) |
static internal double | vtkAnimationCue_GetClockTime_03 (HandleRef pThis) |
static internal double | vtkAnimationCue_GetDeltaTime_04 (HandleRef pThis) |
static internal double | vtkAnimationCue_GetEndTime_05 (HandleRef pThis) |
static internal double | vtkAnimationCue_GetStartTime_06 (HandleRef pThis) |
static internal int | vtkAnimationCue_GetTimeMode_07 (HandleRef pThis) |
static internal void | vtkAnimationCue_Initialize_08 (HandleRef pThis) |
static internal int | vtkAnimationCue_IsA_09 (HandleRef pThis, string type) |
static internal int | vtkAnimationCue_IsTypeOf_10 (string type) |
static internal IntPtr | vtkAnimationCue_NewInstance_12 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal IntPtr | vtkAnimationCue_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount) |
static internal void | vtkAnimationCue_SetEndTime_14 (HandleRef pThis, double _arg) |
static internal void | vtkAnimationCue_SetStartTime_15 (HandleRef pThis, double _arg) |
static internal void | vtkAnimationCue_SetTimeMode_16 (HandleRef pThis, int mode) |
static internal void | vtkAnimationCue_SetTimeModeToNormalized_17 (HandleRef pThis) |
static internal void | vtkAnimationCue_SetTimeModeToRelative_18 (HandleRef pThis) |
static internal void | vtkAnimationCue_Tick_19 (HandleRef pThis, double currenttime, double deltatime, double clocktime) |
Static Private Member Functions | |
static | vtkAnimationCue () |
Automatically generated type registration mechanics. |
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.
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.
static Kitware.VTK.vtkAnimationCue.vtkAnimationCue | ( | ) | [static, private] |
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.
Undocumented Block.
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.
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.
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.
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.
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;.
static internal void Kitware.VTK.vtkAnimationCue.vtkAnimationCue_Finalize_01 | ( | HandleRef | pThis | ) | [private] |
static internal double Kitware.VTK.vtkAnimationCue.vtkAnimationCue_GetAnimationTime_02 | ( | HandleRef | pThis | ) | [private] |
static internal double Kitware.VTK.vtkAnimationCue.vtkAnimationCue_GetClockTime_03 | ( | HandleRef | pThis | ) | [private] |
static internal double Kitware.VTK.vtkAnimationCue.vtkAnimationCue_GetDeltaTime_04 | ( | HandleRef | pThis | ) | [private] |
static internal double Kitware.VTK.vtkAnimationCue.vtkAnimationCue_GetEndTime_05 | ( | HandleRef | pThis | ) | [private] |
static internal double Kitware.VTK.vtkAnimationCue.vtkAnimationCue_GetStartTime_06 | ( | HandleRef | pThis | ) | [private] |
static internal int Kitware.VTK.vtkAnimationCue.vtkAnimationCue_GetTimeMode_07 | ( | HandleRef | pThis | ) | [private] |
static internal void Kitware.VTK.vtkAnimationCue.vtkAnimationCue_Initialize_08 | ( | HandleRef | pThis | ) | [private] |
static internal int Kitware.VTK.vtkAnimationCue.vtkAnimationCue_IsA_09 | ( | HandleRef | pThis, |
string | type | ||
) | [private] |
static internal int Kitware.VTK.vtkAnimationCue.vtkAnimationCue_IsTypeOf_10 | ( | string | type | ) | [private] |
static internal IntPtr Kitware.VTK.vtkAnimationCue.vtkAnimationCue_New | ( | ref uint | mteStatus, |
ref uint | mteIndex, | ||
ref uint | rawRefCount | ||
) | [private] |
static internal IntPtr Kitware.VTK.vtkAnimationCue.vtkAnimationCue_NewInstance_12 | ( | HandleRef | pThis, |
ref uint | mteStatus, | ||
ref uint | mteIndex, | ||
ref uint | rawRefCount | ||
) | [private] |
static internal IntPtr Kitware.VTK.vtkAnimationCue.vtkAnimationCue_SafeDownCast_13 | ( | HandleRef | o, |
ref uint | mteStatus, | ||
ref uint | mteIndex, | ||
ref uint | rawRefCount | ||
) | [private] |
static internal void Kitware.VTK.vtkAnimationCue.vtkAnimationCue_SetEndTime_14 | ( | HandleRef | pThis, |
double | _arg | ||
) | [private] |
static internal void Kitware.VTK.vtkAnimationCue.vtkAnimationCue_SetStartTime_15 | ( | HandleRef | pThis, |
double | _arg | ||
) | [private] |
static internal void Kitware.VTK.vtkAnimationCue.vtkAnimationCue_SetTimeMode_16 | ( | HandleRef | pThis, |
int | mode | ||
) | [private] |
static internal void Kitware.VTK.vtkAnimationCue.vtkAnimationCue_SetTimeModeToNormalized_17 | ( | HandleRef | pThis | ) | [private] |
static internal void Kitware.VTK.vtkAnimationCue.vtkAnimationCue_SetTimeModeToRelative_18 | ( | HandleRef | pThis | ) | [private] |
static internal void Kitware.VTK.vtkAnimationCue.vtkAnimationCue_Tick_19 | ( | HandleRef | pThis, |
double | currenttime, | ||
double | deltatime, | ||
double | clocktime | ||
) | [private] |
new readonly string Kitware.VTK.vtkAnimationCue.MRClassNameKey = "15vtkAnimationCue" [static] |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkObject.
Reimplemented in Kitware.VTK.vtkAnimationScene.
new const string Kitware.VTK.vtkAnimationCue.MRFullTypeName = "Kitware.VTK.vtkAnimationCue" |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkObject.
Reimplemented in Kitware.VTK.vtkAnimationScene.