FAPFrame Class Reference

#include <FAPFrame.h>

List of all members.

Public Member Functions

FAPFrameGetCorrespondingZeroFrame ()
 obtains a copy of the FAP frame with all FAPs to zero
void CopyFrom (FAPFrame *origin)
 stores a given FAP frame into the current
void MergeFrom (FAPFrame *origin)
 merges a given FAP frame into the current
void MergeFAP (int num, int value)
 merge a FAP value to the current frame
void Print ()
 prints the frame on the screen
int SetFAP (int num, int value, bool activate=true)
 sets FAP value
int GetFAP (int num)
 retrieves FAP value
int GetMask (int num)
int AddToFAP (int num, int value)
 merge a FAP value to the current frame
 FAPFrame (void)
 class constructor
 ~FAPFrame (void)
 class destructor
void ActivateAllFAPs (void)
 puts all the FAP masks to 1
void DeactivateAll (void)
 puts all the FAP masks to 0
void ResetAllToZero ()
 reset all the FAP values to 0 and deactivate all the masks
void ActivateAndSetAllFAPsTo (int v)
 sets all the FAP values to a given value
void SaveToFile (FILE *f, int num)
 saves the frame to a file
std::string WriteFAP (int num)
void ReadFromBuffer (char *buffer)
float GetTCBParam (TCBParamType which)
void SetTCBParam (float T, float C, float B)
void SetTension (float T)
void SetContinuity (float C)
void SetBias (float B)
bool operator< (FAPFrame &a)
std::string toString ()
FAPFrame clone ()

Public Attributes

float probability
 probability of the frame
FAP FAPs [NUMBER_OF_FAPS]
 array of the frame's FAPs
bool isKeyFrame
 indicates if the frame is a keyframe
eyesdirection eyesdir
 eyes direction for this frame
headdirection headdir
 head direction for this frame
headmovement headmov
 head movement for this frame
int framenumber
float TCBParam [3]
int use_at
int use_before
int received_at
std::string id

Detailed Description

Definition at line 73 of file FAPFrame.h.


Constructor & Destructor Documentation

FAPFrame::FAPFrame ( void   ) 

class constructor

Definition at line 25 of file FAPFrame.cpp.

FAPFrame::~FAPFrame ( void   ) 

class destructor

Definition at line 55 of file FAPFrame.cpp.


Member Function Documentation

void FAPFrame::ActivateAllFAPs ( void   ) 

puts all the FAP masks to 1

Definition at line 64 of file FAPFrame.cpp.

void FAPFrame::ActivateAndSetAllFAPsTo ( int  v  ) 

sets all the FAP values to a given value

Definition at line 87 of file FAPFrame.cpp.

int FAPFrame::AddToFAP ( int  num,
int  value 
)

merge a FAP value to the current frame

given a FAP number and a value it sums the value to the corresponding FAP in the FAP frame

Definition at line 119 of file FAPFrame.cpp.

FAPFrame FAPFrame::clone (  ) 

Definition at line 383 of file FAPFrame.cpp.

void FAPFrame::CopyFrom ( FAPFrame origin  ) 

stores a given FAP frame into the current

is helpful to copy another frame in the current

Definition at line 205 of file FAPFrame.cpp.

void FAPFrame::DeactivateAll ( void   ) 

puts all the FAP masks to 0

given a FAP number and a value it sums the value to the corresponding FAP in the FAP frame

Definition at line 70 of file FAPFrame.cpp.

FAPFrame * FAPFrame::GetCorrespondingZeroFrame (  ) 

obtains a copy of the FAP frame with all FAPs to zero

it is used when creating keyframes because to animate you need to go from zero values to activation values; so you sometimes need to get a FAP frame which has the right mask (1s in the right places) but with all the values set to 0

Definition at line 226 of file FAPFrame.cpp.

int FAPFrame::GetFAP ( int  num  ) 

retrieves FAP value

given a FAP number it gets the corresponding value

Definition at line 141 of file FAPFrame.cpp.

int FAPFrame::GetMask ( int  num  )  [inline]

Definition at line 119 of file FAPFrame.h.

float FAPFrame::GetTCBParam ( TCBParamType  which  ) 

Definition at line 59 of file FAPFrame.cpp.

void FAPFrame::MergeFAP ( int  num,
int  value 
)

merge a FAP value to the current frame

given a FAP number and a value it sums the value to the corresponding FAP in the FAP frame

Definition at line 196 of file FAPFrame.cpp.

void FAPFrame::MergeFrom ( FAPFrame origin  ) 

merges a given FAP frame into the current

is helpful to merge another frame in the current

Definition at line 214 of file FAPFrame.cpp.

bool FAPFrame::operator< ( FAPFrame a  ) 

Definition at line 347 of file FAPFrame.cpp.

void FAPFrame::Print (  ) 

prints the frame on the screen

Definition at line 146 of file FAPFrame.cpp.

void FAPFrame::ReadFromBuffer ( char *  buffer  ) 

Definition at line 279 of file FAPFrame.cpp.

void FAPFrame::ResetAllToZero (  ) 

reset all the FAP values to 0 and deactivate all the masks

Definition at line 76 of file FAPFrame.cpp.

void FAPFrame::SaveToFile ( FILE *  f,
int  num 
)

saves the frame to a file

Definition at line 238 of file FAPFrame.cpp.

void FAPFrame::SetBias ( float  B  ) 

Definition at line 342 of file FAPFrame.cpp.

void FAPFrame::SetContinuity ( float  C  ) 

Definition at line 337 of file FAPFrame.cpp.

int FAPFrame::SetFAP ( int  num,
int  value,
bool  activate = true 
)

sets FAP value

given a FAP number and a value sets the corresponding FAP in the frame to that value

Definition at line 96 of file FAPFrame.cpp.

void FAPFrame::SetTCBParam ( float  T,
float  C,
float  B 
)

Definition at line 325 of file FAPFrame.cpp.

void FAPFrame::SetTension ( float  T  ) 

Definition at line 332 of file FAPFrame.cpp.

std::string FAPFrame::toString (  ) 

Definition at line 355 of file FAPFrame.cpp.

std::string FAPFrame::WriteFAP ( int  num  ) 

Definition at line 244 of file FAPFrame.cpp.


Member Data Documentation

eyes direction for this frame

Definition at line 173 of file FAPFrame.h.

FAP FAPFrame::FAPs[NUMBER_OF_FAPS]

array of the frame's FAPs

Definition at line 140 of file FAPFrame.h.

Definition at line 182 of file FAPFrame.h.

head direction for this frame

Definition at line 177 of file FAPFrame.h.

head movement for this frame

Definition at line 181 of file FAPFrame.h.

std::string FAPFrame::id

Definition at line 194 of file FAPFrame.h.

indicates if the frame is a keyframe

Definition at line 144 of file FAPFrame.h.

probability of the frame

Definition at line 103 of file FAPFrame.h.

Definition at line 192 of file FAPFrame.h.

Definition at line 183 of file FAPFrame.h.

Definition at line 190 of file FAPFrame.h.

Definition at line 191 of file FAPFrame.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Mon Oct 31 14:42:35 2011 for SO3Engine by  doxygen 1.6.3