Animation System - Revision history

Nickenstein79: /* Interpolator (class {{DoxygenClass|Interpolator|0.7}}) */

2014-07-09T01:19:45Z

‎Interpolator (class {{DoxygenClass|Interpolator|0.7}})

Kornerr: /* Via code */

2012-05-31T14:18:13Z

‎Via code

Kornerr: /* Via code */

2012-05-31T14:17:29Z

‎Via code

Kulik: Also works with 0.8

2011-12-10T20:36:48Z

Also works with 0.8

Pav: /* Via Falagard looknfeel XML */ Add colour animation example

2011-12-10T15:41:06Z

‎Via Falagard looknfeel XML: Add colour animation example

Kulik at 11:57, 26 November 2011

2011-11-26T11:57:15Z

Capek: Experiment to make the wiki more interlinked

2011-03-03T23:13:10Z

Experiment to make the wiki more interlinked

Capek: Lets use instead of , it is much less typo-prone

2011-02-28T11:19:13Z

Lets use <source> instead of <syntaxhighlight>, it is much less typo-prone

Kulik at 11:54, 27 February 2011

2011-02-27T11:54:12Z

Kulik: testing syntax highlight

2011-02-27T11:16:43Z

testing syntax highlight

@@ Line 27: / Line 27: @@
 === Interpolator (class {{DoxygenClass|Interpolator|0.7}}) ===
 To be able to animate smoothly between 2 discrete keyframes, interpolators had to be introduced. You don't have to use them directly, everything is done for you in the animation classes. You only need to understand their internals if you need custom interpolator (as all basic interpolators are included in CEGUI, if you find some property that can't be animated with stock interpolators, let us know).
 == Defining animations ==

@@ Line 53: / Line 53: @@
      CEGUI::Affector* affector = anim->createAffector("Alpha", "float");
      affector->createKeyFrame(0.0f, "1.0"); // at 0.0 seconds, set alpha to 1.0
-     affector->createKeyFrame(0.3f, "0.5", CEGUI::KeyFrame::P_QuadraticDecelerating); // at 1.0 seconds, set alpha to 0.5, now decelerating!
+     affector->createKeyFrame(0.3f, "0.5", CEGUI::KeyFrame::P_QuadraticDecelerating); // at 0.3 seconds, set alpha to 0.5, now decelerating!
+    }
+}

@@ Line 42: / Line 42: @@
      // this affector changes YRotation and interpolates keyframes with float interpolator
      CEGUI::Affector* affector = anim->createAffector("YRotation", "float");
-     // at 0.0 seconds, the animation should set YRotation to 10.0 degrees
+     // at 0.0 seconds, the animation should set YRotation to 0 degrees
      affector->createKeyFrame(0.0f, "0.0");
-     // at 0.3 seconds, YRotation should be 0 degrees and animation should progress towards this in an accelerating manner
+     // at 0.3 seconds, YRotation should be 10.0 degrees and animation should progress towards this in an accelerating manner
      affector->createKeyFrame(0.3f, "10.0", CEGUI::KeyFrame::P_QuadraticAccelerating);
+    }
@@ Line 52: / Line 52: @@
      // this affector will again use float interpolator
      CEGUI::Affector* affector = anim->createAffector("Alpha", "float");
-     affector->createKeyFrame(0.0f, "1.0"); // at 0.0 seconds, set alpha to 0.5
+     affector->createKeyFrame(0.0f, "1.0"); // at 0.0 seconds, set alpha to 1.0
-     affector->createKeyFrame(0.3f, "0.5", CEGUI::KeyFrame::P_QuadraticDecelerating); // at 1.0 seconds, set alpha to 1.0, now decelerating!
+     affector->createKeyFrame(0.3f, "0.5", CEGUI::KeyFrame::P_QuadraticDecelerating); // at 1.0 seconds, set alpha to 0.5, now decelerating!
+    }
+}

← Older revision		Revision as of 20:36, 10 December 2011
Line 1:		Line 1:
−	{{VersionBadge\|0.7}} {{VersionAtLeast\|0.7.2}}	+	{{VersionBadge\|0.7}} {{VersionBadge\|0.8}}
		+	{{VersionAtLeast\|0.7.2}}

	== Prerequisites ==		== Prerequisites ==

@@ Line 72: / Line 72: @@
    </AnimationDefinition>
 </WidgetLook>
 </source>

← Older revision		Revision as of 11:57, 26 November 2011
Line 1:		Line 1:
	{{VersionBadge\|0.7}} {{VersionAtLeast\|0.7.2}}		{{VersionBadge\|0.7}} {{VersionAtLeast\|0.7.2}}
		+
		+	== Prerequisites ==
		+	'''You have to inject time pulses (see System::injectTimePulse), otherwise CEGUI has no idea time is passing and the animations will always be stuck at the position they started at.'''

	== Basic concepts ==		== Basic concepts ==

@@ Line 54: / Line 54: @@
 </source>
-=== Via Falagard looknfeel XML ===
+=== Via [[Falagard]] looknfeel XML ===
 <source lang="xml">
 <WidgetLook ...>
@@ Line 88: / Line 88: @@
 == Instantiating animations ==
-If you created the animation in code or via separate animation definition file, you have to instantiate it (only Falagard instantiates and sets target automatically).
+If you created the animation in code or via separate animation definition file, you have to instantiate it (only [[Falagard]] instantiates and sets target automatically).
 <source lang="cpp">
@@ Line 104: / Line 104: @@
 If you already are using XML to define animations, the easiest solution is to use the auto event subscription facility. You add pairs of Event name and action that should happen with the animation ("Start", "Stop", "Pause", "Unpause", etc.) and when target window is set, these subscriptions are automatically made for your convenienve.
-Both Falagard and Animations.xml approaches are the same with regards to this. This XML snippet starts the animation when mouse enters the target window's area.
+Both [[Falagard]] and Animations.xml approaches are the same with regards to this. This XML snippet starts the animation when mouse enters the target window's area.
 <source lang="xml">
 <AnimationDefinition name="Testing" duration="0.3" replayMode="once">

@@ Line 28: / Line 28: @@
 === Via code ===
 This sample animation takes 0.3 seconds and in that time, it fades the window and rotates it 10 degrees around Y axis.
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
+{
     CEGUI::Animation* anim = CEGUI::AnimationManager::getSingleton().createAnimation("Testing");
@@ Line 52: / Line 52: @@
+    }
+}
-</syntaxhighlight>
+</source>
 === Via Falagard looknfeel XML ===
-<syntaxhighlight lang="xml">
+<source lang="xml">
 <WidgetLook ...>
 ...
@@ Line 69: / Line 69: @@
    </AnimationDefinition>
 </WidgetLook>
-</syntaxhighlight>
+</source>
 === Via separate animation list XML (AnimationManager::loadAnimationsFromXML) ===
-<syntaxhighlight lang="xml">
+<source lang="xml">
 <Animations>
    <AnimationDefinition name="Testing" duration="0.3" replayMode="once">
@@ Line 85: / Line 85: @@
    </AnimationDefinition>
 </Animations>
-</syntaxhighlight>
+</source>
 == Instantiating animations ==
 If you created the animation in code or via separate animation definition file, you have to instantiate it (only Falagard instantiates and sets target automatically).
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
 CEGUI::AnimationInstance* instance = CEGUI::AnimationManager::getSingleton().instantiateAnimation(anim);
 // after we instantiate the animation, we have to set its target window
@@ Line 97: / Line 97: @@
 // at this point, you can start this instance and see the results
 instance->start();
-</syntaxhighlight>
+</source>
 == Connecting events and animations ==
@@ Line 105: / Line 105: @@
 Both Falagard and Animations.xml approaches are the same with regards to this. This XML snippet starts the animation when mouse enters the target window's area.
-<syntaxhighlight lang="xml">
+<source lang="xml">
 <AnimationDefinition name="Testing" duration="0.3" replayMode="once">
    ...
    <Subscription event="MouseEntersArea" action="Start" />
 </AnimationDefinition>
-</syntaxhighlight>
+</source>
 Doing this in code is much more powerful (you can subscribe to a window that's different than target window) but also more messy:
-<syntaxhighlight lang="cpp">
+<source lang="cpp">
 windowWithEvent->subscribeEvent(CEGUI::Window::EventMouseEntersArea, CEGUI::Event::Subscriber(&CEGUI::AnimationInstance::handleStart, instance));
-</syntaxhighlight>
+</source>
 You can also do this from a Lua script:
-<syntaxhighlight lang="lua">
+<source lang="lua">
 CEGUI.WindowManager:getSingleton():getWindow("WindowName"):subscribeEvent("MouseEnter", "luafunctionname")
-</syntaxhighlight>
+</source>
 This code sets up the window specified in WindowName, the name of that window on creation or from the XML "Name" property, to react to the mouse entering it by calling the Lua function specified in luafunctionname. The Lua function name argument should be the name, without trailing (), to a function declared in Lua or exported to Lua from C.
@@ Line 127: / Line 127: @@
 === animations.xml example ===
 Here we have edited the example animation so that the alpha value uses the quadratic deceleration progression. This will make the alpha value drop quickly in the first frames but the speed of the change will decrease quickly and give a smooth finish to the transition.
-<syntaxhighlight lang="xml">
+<source lang="xml">
 <Animations>
    <AnimationDefinition name="Testing" duration="0.3" replayMode="once">
@@ Line 140: / Line 140: @@
    </AnimationDefinition>
 </Animations>
-</syntaxhighlight>
+</source>
 Possible values for this property, in XML, are:
 * "linear": (default value) Simple linear transition. Same rate of progression for every frame.
@@ Line 152: / Line 152: @@
 === animations.xml example: ===
 In the following example we have changed the rotation affector to do relative rotation instead of absolute, which is default. This means that whatever rotation the window had when the animation started it will add the new rotation to that value. The absolute method would have reset the rotation to 0 in the first key frame and then proceeded to rotate it by 10 degrees during 0.3 seconds.
-<syntaxhighlight lang="xml">
+<source lang="xml">
 <Animations>
    <AnimationDefinition name="Testing" duration="0.3" replayMode="once">
@@ Line 165: / Line 165: @@
    </AnimationDefinition>
 </Animations>
-</syntaxhighlight>
+</source>
 Possible values for this property, in XML, are:
 * "absolute": (default setting) The interpolated value is set as the new property value.