newspeoplefor developersdocumentationdownloads

nAnimation::Group Class Reference

#include <nanimation.h>

List of all members.


Detailed Description

holds animation group information (a group of curves)

Definition at line 149 of file nanimation.h.


Public Types

enum  LoopType {
  Clamp = 0,
  Repeat,
  InvalidLoopType
}
 loop types More...

Public Member Functions

 Group ()
 constructor
 ~Group ()
 destructor
void SetNumCurves (int c)
 set number of curves in group
int GetNumCurves () const
 get number of curves in group
CurveGetCurveAt (int i) const
 a curve object at index
void SetStartKey (int k)
 set start key
int GetStartKey () const
 get start key
void SetNumKeys (int k)
 set number of keys (identical for all curves)
int GetNumKeys () const
 get number of keys
void SetKeyStride (int stride)
 set the key stride
int GetKeyStride () const
 get the key stride
void SetKeyTime (float t)
 set the key duration
float GetKeyTime () const
 get the key duration
void SetFadeInFrames (float frames)
 set the number of fade in frames
float GetFadeInFrames () const
 get the number of fade in frames
void SetLoopType (LoopType t)
 set the loop type (identical for all curves)
LoopType GetLoopType () const
 get the loop type
void TimeToIndex (float time, int &keyIndex0, int &keyIndex1, float &inbetween) const
 convert a time stamp into 2 global key indexes and an inbetween value
bool IsInbetween (float time, float startTime, float stopTime) const
 return true if time is between startTime and stopTime (handles looped and clamped case correctly)
nTime GetDuration () const
 get animation duration

Static Public Member Functions

static LoopType StringToLoopType (const char *str)
 convert string to loop type

Member Enumeration Documentation

enum nAnimation::Group::LoopType
 

loop types

Enumerator:
Clamp 
Repeat 
InvalidLoopType 

Definition at line 153 of file nanimation.h.


Constructor & Destructor Documentation

nAnimation::Group::Group  )  [inline]
 

constructor

Definition at line 399 of file nanimation.h.

nAnimation::Group::~Group  )  [inline]
 

destructor

Definition at line 415 of file nanimation.h.


Member Function Documentation

void nAnimation::Group::SetNumCurves int  c  )  [inline]
 

set number of curves in group

Definition at line 425 of file nanimation.h.

int nAnimation::Group::GetNumCurves  )  const [inline]
 

get number of curves in group

Definition at line 435 of file nanimation.h.

nAnimation::Curve & nAnimation::Group::GetCurveAt int  i  )  const [inline]
 

a curve object at index

Definition at line 445 of file nanimation.h.

void nAnimation::Group::SetStartKey int  k  )  [inline]
 

set start key

Definition at line 456 of file nanimation.h.

int nAnimation::Group::GetStartKey  )  const [inline]
 

get start key

Definition at line 466 of file nanimation.h.

void nAnimation::Group::SetNumKeys int  k  )  [inline]
 

set number of keys (identical for all curves)

Definition at line 476 of file nanimation.h.

int nAnimation::Group::GetNumKeys  )  const [inline]
 

get number of keys

Definition at line 486 of file nanimation.h.

void nAnimation::Group::SetKeyStride int  stride  )  [inline]
 

set the key stride

Definition at line 496 of file nanimation.h.

int nAnimation::Group::GetKeyStride  )  const [inline]
 

get the key stride

Definition at line 506 of file nanimation.h.

void nAnimation::Group::SetKeyTime float  t  )  [inline]
 

set the key duration

Definition at line 516 of file nanimation.h.

float nAnimation::Group::GetKeyTime  )  const [inline]
 

get the key duration

Definition at line 526 of file nanimation.h.

void nAnimation::Group::SetFadeInFrames float  frames  )  [inline]
 

set the number of fade in frames

Definition at line 536 of file nanimation.h.

float nAnimation::Group::GetFadeInFrames  )  const [inline]
 

get the number of fade in frames

Definition at line 546 of file nanimation.h.

void nAnimation::Group::SetLoopType LoopType  t  )  [inline]
 

set the loop type (identical for all curves)

Definition at line 556 of file nanimation.h.

nAnimation::Group::LoopType nAnimation::Group::GetLoopType  )  const [inline]
 

get the loop type

Definition at line 566 of file nanimation.h.

nAnimation::Group::LoopType nAnimation::Group::StringToLoopType const char *  str  )  [inline, static]
 

convert string to loop type

Definition at line 576 of file nanimation.h.

void nAnimation::Group::TimeToIndex float  time,
int &  keyIndex0,
int &  keyIndex1,
float &  inbetween
const [inline]
 

convert a time stamp into 2 global key indexes and an inbetween value

  • 18-Oct-04 floh fixed case where returned indexes could be <0

Definition at line 617 of file nanimation.h.

bool nAnimation::Group::IsInbetween float  time,
float  startTime,
float  stopTime
const [inline]
 

return true if time is between startTime and stopTime (handles looped and clamped case correctly)

Return true if absolute time is between relative start and stop time. This will handle the case where the curve is looped and time is out of bounds correctly.

Convert an absolute time into a normalized time. If the group is looped, this will return a time within start and end.

Definition at line 594 of file nanimation.h.

nTime nAnimation::Group::GetDuration  )  const [inline]
 

get animation duration

Definition at line 658 of file nanimation.h.


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

Copyright © 1999-2005 by the contributing authors. Ideas, requests, problems: Send feedback.