Public Member Functions | Public Attributes

KFCurveEvent Class Reference

Search for all occurrences

Detailed Description

Animation curve event class.

An animation curve event happens when there is some action performed on a curve through a graphical interface. The FBX SDK doesn't have such an interface, and this class is not used in the SDK. An example of animation curve event would be a key value modification through the interface.

Definition at line 338 of file kfcurve.h.

#include <kfcurve.h>

Inheritance diagram for KFCurveEvent:
Inheritance graph
[legend]

List of all members.

Public Member Functions

KFBX_FCURVE_INLINE void  Clear ()
  Reset the count of events (KFCurveEvent::mEventCount) to 0.
KFBX_FCURVE_INLINE void  Add (int pWhat, int pIndex)
  Add a curve event of type given pWhat to a curve event object.

Public Attributes

int  mKeyIndexStart
  Index of the key where the event begins.
int  mKeyIndexStop
  Index of the key where the event ends.
int  mEventCount
  Number of events, can be reset to 0 with KFCurveEvent::Clear.

Member Function Documentation

KFBX_FCURVE_INLINE void Clear ( )

Reset the count of events (KFCurveEvent::mEventCount) to 0.

Definition at line 2500 of file kfcurve.h.

KFBX_FCURVE_INLINE void Add ( int  pWhat,
int  pIndex 
)

Add a curve event of type given pWhat to a curve event object.

Parameters:
pWhat Type of event, for example: KFCURVEEVENT_NONE, KFCURVEEVENT_CANDIDATE, KFCURVEEVENT_KEY.
pIndex Index of the key for which the event occurred

Definition at line 2508 of file kfcurve.h.

{       
    mType |= pWhat;
    mEventCount++;
    if ( (pIndex<mKeyIndexStart) || (mKeyIndexStart==-1)) 
    {
        mKeyIndexStart = pIndex;
    }
    if (pIndex>mKeyIndexStop) 
    {
        mKeyIndexStop = pIndex;
    }
}

Member Data Documentation

Index of the key where the event begins.

Definition at line 345 of file kfcurve.h.

Index of the key where the event ends.

Definition at line 347 of file kfcurve.h.

Number of events, can be reset to 0 with KFCurveEvent::Clear.

Definition at line 349 of file kfcurve.h.


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

KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent
KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent KFCurveEvent