OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Types | Public Member Functions | Public Attributes | Protected Attributes | Properties | List of all members
OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator Class Reference

Handle all animation duties for a scene presence More...

Collaboration diagram for OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator:
Collaboration graph
[legend]

Public Types

enum  motionControlStates : byte {
  motionControlStates.sitted = 0, motionControlStates.flying, motionControlStates.falling, motionControlStates.jumping,
  motionControlStates.landing, motionControlStates.onsurface
}
 

Public Member Functions

 ScenePresenceAnimator (ScenePresence sp)
 
void AddAnimation (UUID animID, UUID objectID)
 
void AddAnimation (string name, UUID objectID)
 
void RemoveAnimation (UUID animID, bool allowNoDefault)
 Remove the specified animation More...
 
void avnChangeAnim (UUID animID, bool addRemove, bool sendPack)
 
void RemoveAnimation (string name)
 
void ResetAnimations ()
 
bool TrySetMovementAnimation (string anim)
 The movement animation is reserved for "main" animations that are mutually exclusive, e.g. flying and sitting. More...
 
bool UpdateMovementAnimations ()
 Update the movement animation of this avatar according to its current state More...
 
bool ForceUpdateMovementAnimations ()
 
bool SetMovementAnimations (string motionState)
 
UUID[] GetAnimationArray ()
 
BinBVHAnimation GenerateRandomAnimation ()
 
void SendAnimPack (UUID[] animations, int[] seqs, UUID[] objectIDs)
 
void GetArrays (out UUID[] animIDs, out int[] sequenceNums, out UUID[] objectIDs)
 
void SendAnimPackToClient (IClientAPI client)
 
void SendAnimPack ()
 Send animation information about this avatar to all clients. More...
 
string GetAnimName (UUID animId)
 

Public Attributes

bool m_jumping = false
 
motionControlStates currentControlState = motionControlStates.onsurface
 

Protected Attributes

AnimationSet m_animations = new AnimationSet()
 
ScenePresence m_scenePresence
 

Properties

AnimationSet Animations [get]
 
string CurrentMovementAnimation [get, set]
 
bool Falling [get, set]
 Is the avatar falling? More...
 

Detailed Description

Handle all animation duties for a scene presence

Definition at line 45 of file ScenePresenceAnimator.cs.

Member Enumeration Documentation

enum OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.motionControlStates : byte
Enumerator
sitted 
flying 
falling 
jumping 
landing 
onsurface 

Definition at line 263 of file ScenePresenceAnimator.cs.

Constructor & Destructor Documentation

OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.ScenePresenceAnimator ( ScenePresence  sp)
inline

Definition at line 80 of file ScenePresenceAnimator.cs.

Member Function Documentation

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.AddAnimation ( UUID  animID,
UUID  objectID 
)
inline

Definition at line 86 of file ScenePresenceAnimator.cs.

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.AddAnimation ( string  name,
UUID  objectID 
)
inline

Definition at line 105 of file ScenePresenceAnimator.cs.

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.avnChangeAnim ( UUID  animID,
bool  addRemove,
bool  sendPack 
)
inline

Definition at line 146 of file ScenePresenceAnimator.cs.

bool OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.ForceUpdateMovementAnimations ( )
inline

Definition at line 589 of file ScenePresenceAnimator.cs.

BinBVHAnimation OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.GenerateRandomAnimation ( )
inline

Definition at line 616 of file ScenePresenceAnimator.cs.

UUID [] OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.GetAnimationArray ( )
inline

Definition at line 607 of file ScenePresenceAnimator.cs.

string OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.GetAnimName ( UUID  animId)
inline

Definition at line 729 of file ScenePresenceAnimator.cs.

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.GetArrays ( out UUID[]  animIDs,
out int[]  sequenceNums,
out UUID[]  objectIDs 
)
inline

Definition at line 686 of file ScenePresenceAnimator.cs.

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.RemoveAnimation ( UUID  animID,
bool  allowNoDefault 
)
inline

Remove the specified animation

Parameters
animID
allowNoDefaultIf true, then the default animation can be entirely removed. If false, then removing the default animation will reset it to the simulator default (currently STAND).

Definition at line 129 of file ScenePresenceAnimator.cs.

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.RemoveAnimation ( string  name)
inline

Definition at line 163 of file ScenePresenceAnimator.cs.

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.ResetAnimations ( )
inline

Definition at line 177 of file ScenePresenceAnimator.cs.

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.SendAnimPack ( UUID[]  animations,
int[]  seqs,
UUID[]  objectIDs 
)
inline

Parameters
animations
seqs
objectIDs

Definition at line 681 of file ScenePresenceAnimator.cs.

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.SendAnimPack ( )
inline

Send animation information about this avatar to all clients.

Definition at line 712 of file ScenePresenceAnimator.cs.

void OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.SendAnimPackToClient ( IClientAPI  client)
inline

Definition at line 696 of file ScenePresenceAnimator.cs.

bool OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.SetMovementAnimations ( string  motionState)
inline

Definition at line 598 of file ScenePresenceAnimator.cs.

bool OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.TrySetMovementAnimation ( string  anim)
inline

The movement animation is reserved for "main" animations that are mutually exclusive, e.g. flying and sitting.

Returns
'true' if the animation was updated

Definition at line 199 of file ScenePresenceAnimator.cs.

bool OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.UpdateMovementAnimations ( )
inline

Update the movement animation of this avatar according to its current state

Returns
'true' if the animation was changed

Definition at line 565 of file ScenePresenceAnimator.cs.

Member Data Documentation

motionControlStates OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.currentControlState = motionControlStates.onsurface

Definition at line 273 of file ScenePresenceAnimator.cs.

AnimationSet OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.m_animations = new AnimationSet()
protected

Definition at line 53 of file ScenePresenceAnimator.cs.

bool OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.m_jumping = false

Definition at line 64 of file ScenePresenceAnimator.cs.

ScenePresence OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.m_scenePresence
protected

The scene presence that this animator applies to

Definition at line 78 of file ScenePresenceAnimator.cs.

Property Documentation

AnimationSet OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.Animations
get

Definition at line 50 of file ScenePresenceAnimator.cs.

string OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.CurrentMovementAnimation
getset

The current movement animation

Definition at line 58 of file ScenePresenceAnimator.cs.

bool OpenSim.Region.Framework.Scenes.Animation.ScenePresenceAnimator.Falling
getset

Is the avatar falling?

Definition at line 71 of file ScenePresenceAnimator.cs.


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