QSDK 1.1 Documentation
Main Page | Modules | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members | Related Pages

Q::AnimationMachineEd Struct Reference
[Animation Extended Editing API]

The animation machine (abbreviated as QAM). More...

#include <Q/animation.h>

Inheritance diagram for Q::AnimationMachineEd:

Q::AnimationMachine Com::Unknown List of all members.

Public Types

typedef Com::Ptr< AnimationMachineEd > PTR

Public Member Functions

virtual Animation animation () const=0
virtual void setAnimation (const Animation &)=0
virtual Utils::Result getState (AnimationStateEd **) const=0
AnimationStateEd::PTR state () const
virtual Utils::Result getMode (AnimationModeEd **) const=0
AnimationModeEd::PTR mode () const
virtual unsigned int modeCount () const=0
virtual Utils::Result getMode (unsigned int, AnimationModeEd **) const=0
AnimationModeEd::PTR mode (unsigned int) const
virtual unsigned int failureCount () const=0
virtual Utils::Result getFailure (unsigned int, AnimationModeEd **) const=0
AnimationModeEd::PTR failure (unsigned int) const
virtual unsigned int stateCount () const=0
virtual Utils::Result getState (unsigned int i, AnimationStateEd **) const=0
AnimationStateEd::PTR state (unsigned int i) const
virtual unsigned int childrenCount () const=0
virtual Utils::Result getChild (unsigned int, AnimationMachineEd **) const=0
PTR child (unsigned int) const
virtual float speed () const=0
virtual Utils::Result getIndexNode (IndexNodeEd **) const=0
Com::Ptr< IndexNodeEd > indexNode () const
virtual Utils::Result getStart (AnimationStateEd **) const=0
AnimationStateEd::PTR start () const
virtual Utils::Result changeState (AnimationStateEd *)=0
virtual bool changeMode (AnimationModeEd *)=0
virtual Utils::Result setSpeed (float)=0
virtual Utils::Result setTarget (AnimationTargetEd *)=0
virtual Utils::Result setIndexNode (IndexNodeEd *)=0
virtual Utils::Result setStart (AnimationStateEd *)=0
virtual Utils::Result addState (AnimationStateEd *)=0
virtual Utils::Result removeState (AnimationStateEd *)=0
virtual Utils::Result addMode (AnimationModeEd *)=0
virtual Utils::Result removeMode (AnimationModeEd *)=0
virtual Utils::Result addFailure (AnimationModeEd *)=0
virtual Utils::Result removeFailure (AnimationModeEd *)=0
virtual Utils::Result addChild (AnimationMachineEd *)=0
virtual Utils::Result removeChild (AnimationMachineEd *)=0
virtual Utils::Result getClone (AnimationMachineEd **) const=0
PTR clone () const
virtual Utils::Result addEventListener (AnimationEventListenerEd *)=0
virtual Utils::Result removeEventListener (AnimationEventListenerEd *)=0
virtual Utils::Result addMachineListener (AnimationMachineListenerEd *)=0
virtual Utils::Result removeMachineListener (AnimationMachineListenerEd *)=0

Static Public Member Functions

PTR create ()

Static Public Attributes

Com::UUID IID
Com::UUID CLSID

Detailed Description

The animation machine (abbreviated as QAM).

A machine uses sequences as states and defines transitions betwen them. It has one and only one mode at a time and that mode determines its transitions. Machines can have machines as children in order to delegate control to a subpart.

See also:
The QAM documentation is available here.

Member Typedef Documentation

typedef Com::Ptr<AnimationMachineEd> Q::AnimationMachineEd::PTR
 

A COM pointer to an object of this class

Reimplemented from Q::AnimationMachine.

Member Function Documentation

virtual Utils::Result Q::AnimationMachineEd::addChild (  AnimationMachineEd *   )  [pure virtual]
 

Add a child

virtual Utils::Result Q::AnimationMachineEd::addEventListener (  AnimationEventListenerEd *   )  [pure virtual]
 

Add an AnimationEventListenerEd

virtual Utils::Result Q::AnimationMachineEd::addFailure (  AnimationModeEd *   )  [pure virtual]
 

Add a mode to the set of modes refused by this machine

virtual Utils::Result Q::AnimationMachineEd::addMachineListener (  AnimationMachineListenerEd *   )  [pure virtual]
 

Add an AnimationMachineListenerEd

virtual Utils::Result Q::AnimationMachineEd::addMode (  AnimationModeEd *   )  [pure virtual]
 

Add a mode to the set of modes accepted by this machine

virtual Utils::Result Q::AnimationMachineEd::addState (  AnimationStateEd *   )  [pure virtual]
 

Add a state

virtual Animation Q::AnimationMachineEd::animation (   )  const [pure virtual]
 

The animation

virtual bool Q::AnimationMachineEd::changeMode (  AnimationModeEd *   )  [pure virtual]
 

Request the current mode to change.

Returns:
False iff this mode is refused by the machine

virtual Utils::Result Q::AnimationMachineEd::changeState (  AnimationStateEd *   )  [pure virtual]
 

Request the current state to change

AnimationMachineEd::PTR Q::AnimationMachineEd::child (  unsigned  int  )  const [inline]
 

See also:
getChild

virtual unsigned int Q::AnimationMachineEd::childrenCount (   )  const [pure virtual]
 

The number of children

AnimationMachineEd::PTR Q::AnimationMachineEd::clone (   )  const [inline]
 

See also:
getClone

AnimationMachineEd::PTR Q::AnimationMachineEd::create (   )  [inline, static]
 

Create an AnimationMachineEd

AnimationModeEd::PTR Q::AnimationMachineEd::failure (  unsigned  int  )  const [inline]
 

See also:
getFailure

virtual unsigned int Q::AnimationMachineEd::failureCount (   )  const [pure virtual]
 

The number of modes refused by this machine

virtual Utils::Result Q::AnimationMachineEd::getChild (  unsigned  int,
AnimationMachineEd ** 
)  const [pure virtual]
 

The i-th children.

Note:
The reference count of the AnimationMachineEd will be increased by one after - the caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::AnimationMachineEd::getClone (  AnimationMachineEd **   )  const [pure virtual]
 

Clone the machine.

Note:
The reference count of the AnimationMachineEd will be one after creation. The caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::AnimationMachineEd::getFailure (  unsigned  int,
AnimationModeEd ** 
)  const [pure virtual]
 

The i-th mode refused by this machine.

Note:
The reference count of the AnimationModeEd will be increased by one after - the caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::AnimationMachineEd::getIndexNode (  IndexNodeEd **   )  const [pure virtual]
 

The indices used by the machine.

Note:
It is shared by the machine and all its clones

The reference count of the IndexNodeEd will be increased by one after - the caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::AnimationMachineEd::getMode (  unsigned  int,
AnimationModeEd ** 
)  const [pure virtual]
 

The i-th mode accepted by this machine.

Note:
The reference count of the AnimationModeEd will be increased by one after - the caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::AnimationMachineEd::getMode (  AnimationModeEd **   )  const [pure virtual]
 

The current mode.

Note:
The reference count of the AnimationModeEd will be increased by one after - the caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::AnimationMachineEd::getStart (  AnimationStateEd **   )  const [pure virtual]
 

The state this machine starts from by default.

Note:
The reference count of the AnimationStateEd will be increased by one after - the caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::AnimationMachineEd::getState (  unsigned int  i,
AnimationStateEd ** 
)  const [pure virtual]
 

The i-th state.

Note:
The reference count of the AnimationStateEd will be increased by one after - the caller should release this reference using Com::Unknown::release.

virtual Utils::Result Q::AnimationMachineEd::getState (  AnimationStateEd **   )  const [pure virtual]
 

The current state.

Note:
The reference count of the AnimationStateEd will be increased by one after - the caller should release this reference using Com::Unknown::release.

Com::Ptr< IndexNodeEd > Q::AnimationMachineEd::indexNode (   )  const [inline]
 

See also:
getIndexNode

AnimationModeEd::PTR Q::AnimationMachineEd::mode (  unsigned  int  )  const [inline]
 

See also:
getMode

AnimationModeEd::PTR Q::AnimationMachineEd::mode (   )  const [inline]
 

See also:
getMode

Reimplemented from Q::AnimationMachine.

virtual unsigned int Q::AnimationMachineEd::modeCount (   )  const [pure virtual]
 

The number of modes accepted by this machine

virtual Utils::Result Q::AnimationMachineEd::removeChild (  AnimationMachineEd *   )  [pure virtual]
 

Remove a child

virtual Utils::Result Q::AnimationMachineEd::removeEventListener (  AnimationEventListenerEd *   )  [pure virtual]
 

Remove an AnimationEventListenerEd

virtual Utils::Result Q::AnimationMachineEd::removeFailure (  AnimationModeEd *   )  [pure virtual]
 

Remove a mode from the set of modes refused by this machine

virtual Utils::Result Q::AnimationMachineEd::removeMachineListener (  AnimationMachineListenerEd *   )  [pure virtual]
 

Remove an AnimationMachineListenerEd

virtual Utils::Result Q::AnimationMachineEd::removeMode (  AnimationModeEd *   )  [pure virtual]
 

Remove a mode from the set of modes accepted by this machine

virtual Utils::Result Q::AnimationMachineEd::removeState (  AnimationStateEd *   )  [pure virtual]
 

Remove a state

virtual void Q::AnimationMachineEd::setAnimation (  const Animation &   )  [pure virtual]
 

Set the animation

virtual Utils::Result Q::AnimationMachineEd::setIndexNode (  IndexNodeEd *   )  [pure virtual]
 

The indices used by this machine

Note:
The index definition is shared by the machine and all its clones. The target must be set again so that the index set gets recomputed.

virtual Utils::Result Q::AnimationMachineEd::setSpeed (  float   )  [pure virtual]
 

The speed

Implements Q::AnimationMachine.

virtual Utils::Result Q::AnimationMachineEd::setStart (  AnimationStateEd *   )  [pure virtual]
 

The state this machine starts from by default

virtual Utils::Result Q::AnimationMachineEd::setTarget (  AnimationTargetEd *   )  [pure virtual]
 

Set the target of the machine. A target is necessary for the machine to run. It describes the actual geometry the machine animates.

virtual float Q::AnimationMachineEd::speed (   )  const [pure virtual]
 

The speed

Implements Q::AnimationMachine.

AnimationStateEd::PTR Q::AnimationMachineEd::start (   )  const [inline]
 

See also:
getStart

AnimationStateEd::PTR Q::AnimationMachineEd::state (  unsigned int  i  )  const [inline]
 

See also:
getState

AnimationStateEd::PTR Q::AnimationMachineEd::state (   )  const [inline]
 

See also:
getState

virtual unsigned int Q::AnimationMachineEd::stateCount (   )  const [pure virtual]
 

The number of states

Member Data Documentation

Com::UUID Q::AnimationMachineEd::CLSID [static]
 

COM CLSID db86aeba-b714-491a-bd30-34eab1afb349

Com::UUID Q::AnimationMachineEd::IID [static]
 

COM IID 17cf3a0d-2d8d-4efa-a6ad-d68444189189

Reimplemented from Q::AnimationMachine.

Return to QSDK documentation Contents page. Contact details for support, information and fault-reporting.
Qube Software Limited © 2000-2004