|
wavelength 1.0.0
|
Animation of a transformable's local transform by rotation, translation, and scale keys. More...
#include <rndtransanim.h>


Public Types | |
| enum | Interp { kInterpLinear = 0 , kInterpSpline = 1 } |
| How the translation and scale keys interpolate. More... | |
| Public Types inherited from RndAnimatable | |
| enum | FilterType { kFilterScaleOffset = 0 , kFilterMinMaxLoop = 1 , kFilterZeroOrder = 2 , kFilterFirstOrder = 3 , kFilterSecondOrder = 4 } |
| The type tags of the filters, as Save() writes them. More... | |
Public Member Functions | |
| RndTransAnim (const char *pszName) | |
| Construct an animation of nothing with spline translation, linear scale, and no keys. | |
| ~RndTransAnim () override | |
| Drop the references on the target and the frames owner. | |
| float | EndFrame () override |
| Report the last frame of any key. | |
| void | ListAnimObjects (std::list< RndObject * > &objects) override |
| Add the target to a list, then the objects of the children. | |
| int | SetFrameSelf (float fFrame) override |
| Apply a frame to the target's local transform. | |
| virtual float | StartFrame () |
| Report the first frame of any key. | |
| void | DumpText (PrnStream &stream) override |
| Write a description of the animation and its bases. | |
| void | Save (BinStream &stream) override |
| Write the animation and its bases. | |
| void | Replace (RndObject *pFrom, RndObject *pTo) override |
| Replace a referenced object with another. | |
| const char * | ClassName () const override |
| Report the class name. | |
| void | Copy (const RndObject *pSource, int nFlags) override |
| Copy another animation and its bases. | |
| void | Load (BinStream &stream) override |
| Read what Save() wrote, or an earlier version of it. | |
| void | SetTrans (RndTransformable *pTrans) |
| Set the transformable the animation drives. | |
| void | SetFramesOwner (RndTransAnim *pOwner) |
| Take the keys from another animation. | |
| void | MakeTransform (float fFrame, Transform &xfm, int bWhole) |
| Build the transform at a frame. | |
| float | PathLength (float fStart, float fEnd) |
| Measure the length of the translation path between two frames. | |
| RndTransAnim * | GetFramesOwner () const |
| const std::vector< Key< Quat > > & | GetRotKeys () const |
| std::vector< Key< Quat > > & | GetRotKeys () |
| void | SetRotKeys (const std::vector< Key< Quat > > &keys) |
| const std::vector< Key< Vector3 > > & | GetScaleKeys () const |
| std::vector< Key< Vector3 > > & | GetScaleKeys () |
| void | SetScaleKeys (const std::vector< Key< Vector3 > > &keys) |
| RndTransformable * | GetTrans () const |
| int | GetTransInterp () const |
| void | SetTransInterp (int nTransInterp) |
| const std::vector< Key< Vector3 > > & | GetTransKeys () const |
| std::vector< Key< Vector3 > > & | GetTransKeys () |
| void | SetTransKeys (const std::vector< Key< Vector3 > > &keys) |
| Public Member Functions inherited from RndAnimatable | |
| RndAnimatable () | |
| Construct an animatable at frame 0 without children or filters. | |
| ~RndAnimatable () override | |
| Drop the references on the children and delete the filters. | |
| RndAnimatable * | Parent () |
| Find the animatable whose children include this one. | |
| void | SetFrame (float fFrame) |
| Filter a frame, apply it, and pass the result on to the children. | |
| float | FilterFrame (float fValue) |
| Run a frame through the filters. | |
| float | UnfilterFrame (float fValue) |
| Run a filtered frame back through the filters, last first. | |
| float | ChildrenEndFrame () |
| Report the latest end frame of the children, unfiltered through this animatable. | |
| bool | AddAnim (RndAnimatable *pAnim) |
| Append a child. | |
| void | RemoveAnim (RndAnimatable *pAnim) |
| Remove a child. | |
| void | RemoveAllAnims () |
| Remove every child. | |
| const std::list< Filter * > & | GetFilters () const |
| float | GetFrame () const |
| float | GetFilteredFrame () const |
| const std::list< RndAnimatable * > & | GetAnims () const |
| std::list< Filter * > & | GetFilters () |
| Public Member Functions inherited from RndObject | |
| RndObject (const char *pszName) | |
| Construct an object and register it under a name. | |
| virtual | ~RndObject () |
| Notify every referrer, then erase the registration. | |
| void | SetName (const char *pszName) |
| Register the object under a different name. | |
| void | AddRef (RndObject *pReferrer) |
| Register an object as a store of a pointer to this one. | |
| void | RemoveRef (RndObject *pReferrer) |
| Drop the first registration AddRef() made for a referrer. | |
| const char * | GetName () const |
| const std::list< RndObject * > & | GetRefs () const |
| int | GetInternal () const |
| void | SetInternal (int nInternal) |
| Public Member Functions inherited from RndDrawable | |
| RndDrawable () | |
| Construct a showing drawable without a highlight or children. | |
| ~RndDrawable () override | |
| Drop the references on the children. | |
| virtual void | ListDrawObjects (std::list< RndObject * > &objects) |
| Add the objects the drawable uses to a list. | |
| virtual void | ListDrawables (std::list< RndDrawable * > &drawables) |
| Add the drawables to draw this frame to a list. | |
| virtual void | SetShowing (int nShowing) |
| Set whether the drawable draws at all. | |
| virtual void | SetHighlight (int nHighlight) |
| Set whether the drawable draws with its highlight treatment. | |
| virtual int | DrawShowing () |
| Draw the drawable alone. | |
| RndDrawable * | Parent () |
| Find the drawable whose children include this one. | |
| void | Draw () |
| Draw the drawable and then its children, when it is showing. | |
| bool | AddDraw (RndDrawable *pDraw, RndDrawable *pBefore) |
| Add a child before another. | |
| void | RemoveDraw (RndDrawable *pDraw) |
| Remove a child. | |
| void | ClearDraws () |
| Remove every child. | |
| int | GetShowing () const |
| const std::list< RndDrawable * > & | GetDraws () const |
Static Public Member Functions | |
| static RndObject * | New (const char *pszName) |
| Create an animation. | |
| Static Public Member Functions inherited from RndAnimatable | |
| static Filter * | NewFilter (int nType) |
| Create a filter stage of a type, with its parameters unset. | |
| static void | CollectChildren (std::list< RndObject * > &objects, RndAnimatable *pAnimatable) |
| Append every animation descendant of an animatable, depth first, each before its descendants. | |
| Static Public Member Functions inherited from RndDrawable | |
| static void | CollectChildren (std::list< RndObject * > &objects, RndDrawable *pDrawable) |
| Append every draw descendant of a drawable, depth first, each before its descendants. | |
Static Public Attributes | |
| static constexpr int | kCopyShareKeys = 0x100 |
| The bit of the Copy() flags that shares the source's keys rather than copying them. | |
| static const char * | sClassName |
| The class name a .rnd file writes, TransAnim. | |
| static int | sRev |
| The format version Save() writes and Load() accepts. | |
| Static Public Attributes inherited from RndAnimatable | |
| static int | sRev |
| The format version Save() writes and Load() accepts. | |
| Static Public Attributes inherited from RndObject | |
| static constexpr int | kCopyChildLists = 0x200 |
| The bit of the Copy() flags that copies the child lists of the mix-ins. | |
| Static Public Attributes inherited from RndDrawable | |
| static int | sRev |
| The format version Save() writes and Load() accepts. | |
Protected Member Functions | |
| void | ReleaseRefs () |
| Drop the references on the target and the frames owner. | |
| void | AcquireRefs () |
| Take references on the target and the frames owner. | |
| float | SegmentLength (int nFrom, int nTo, float fStep, float fStart, float fEnd) |
| Measure the translation path between two keys, from one position to another. | |
| Protected Member Functions inherited from RndAnimatable | |
| void | ReleaseObjects () |
| Drop the references on the children without emptying the list, and delete the filters. | |
| void | AcquireAnimRefs () |
| Take a reference on every child. | |
| Protected Member Functions inherited from RndDrawable | |
| void | ReleaseDrawRefs () |
| Drop the reference on every child without emptying the list. | |
| void | AcquireDrawRefs () |
| Take a reference on every child. | |
Additional Inherited Members | |
| Protected Attributes inherited from RndAnimatable | |
| std::list< RndAnimatable * > | mAnims |
| std::list< Filter * > | mFilters |
| float | mFrame |
| float | mFilteredFrame |
| Protected Attributes inherited from RndObject | |
| std::list< RndObject * > | mRefs |
| String | mName |
| Protected Attributes inherited from RndDrawable | |
| int | mShowing |
Animation of a transformable's local transform by rotation, translation, and scale keys.
The RTTI includes the class name and records RndAnimatable and RndDrawable as bases. The keys may be shared, in which case mFramesOwner identifies the animation that has them.
| enum RndTransAnim::Interp |
|
explicit |
Construct an animation of nothing with spline translation, linear scale, and no keys.
The animation is its own frames owner.
| pszName | The registry key. |
|
override |
Drop the references on the target and the frames owner.
|
overridevirtual |
Report the last frame of any key.
Reimplemented from RndAnimatable.
|
overridevirtual |
Add the target to a list, then the objects of the children.
| objects | The list to add to. |
Reimplemented from RndAnimatable.
|
overridevirtual |
Apply a frame to the target's local transform.
| fFrame | The frame. |
Reimplemented from RndAnimatable.
|
virtual |
Report the first frame of any key.
The name is inferred.
|
overridevirtual |
Write a description of the animation and its bases.
| stream | The stream to write to. |
Reimplemented from RndAnimatable.
|
overridevirtual |
Write the animation and its bases.
| stream | The stream to write to. |
Reimplemented from RndAnimatable.
Replace a referenced object with another.
A frames owner replaced by null becomes the animation itself.
| pFrom | The object being replaced. |
| pTo | The replacement, or null. |
Reimplemented from RndAnimatable.
|
inlineoverridevirtual |
Report the class name.
Implements RndObject.
|
overridevirtual |
Copy another animation and its bases.
The keys are copied when the source has its own and the flags do not request sharing. Otherwise the source's frames owner becomes this one's.
| pSource | The animation to copy from. |
| nFlags | The set of fields to copy. |
Reimplemented from RndAnimatable.
|
overridevirtual |
Read what Save() wrote, or an earlier version of it.
| stream | The stream to read from. |
Reimplemented from RndAnimatable.
| void RndTransAnim::SetTrans | ( | RndTransformable * | pTrans | ) |
Set the transformable the animation drives.
| pTrans | The target, or null. |
| void RndTransAnim::SetFramesOwner | ( | RndTransAnim * | pOwner | ) |
Take the keys from another animation.
| pOwner | The animation that has the keys, or null. |
| void RndTransAnim::MakeTransform | ( | float | fFrame, |
| Transform & | xfm, | ||
| int | bWhole ) |
Build the transform at a frame.
A repeating translation adds the distance of each completed pass. A path-following animation turns the basis along the path. A channel without keys leaves its part of the transform unchanged, or sets it to the identity when asked to.
| fFrame | The frame. |
| xfm | Receives the transform. |
| bWhole | Non-zero to set the parts that have no keys to the identity. |
| float RndTransAnim::PathLength | ( | float | fStart, |
| float | fEnd ) |
Measure the length of the translation path between two frames.
The name is inferred.
| fStart | The first frame. |
| fEnd | The last frame. |
|
inlinestatic |
Create an animation.
| pszName | The registry key. |
|
inline |
| keys | The rotation keys. |
| keys | The scale keys. |
|
inline |
|
inline |
|
inline |
| nTransInterp | The Interp of the translation keys. |
| keys | The translation keys. |
|
protected |
Drop the references on the target and the frames owner.
The name is inferred.
|
protected |
Take references on the target and the frames owner.
The name is inferred.
|
protected |
Measure the translation path between two keys, from one position to another.
A linear path is measured as the straight distance between the keys whatever the positions. The name is inferred.
| nFrom | The first key. |
| nTo | The second key. |
| fStep | The step a spline path is sampled at. |
| fStart | The position to start at, from 0 to 1. |
| fEnd | The position to stop at, from 0 to 1. |
|
staticconstexpr |
The bit of the Copy() flags that shares the source's keys rather than copying them.
|
static |
The class name a .rnd file writes, TransAnim.
|
static |