Open Reality Reference Guide
FBCurveEvaluationEvent Class Reference

This class is used when an evaluation must be done on your custom tangents. It contains the necessary information to do the evaluation. More...

#include <fbdata.h>

Inheritance diagram for FBCurveEvaluationEvent:

Public Member Functions

 FBCurveEvaluationEvent (HKEventBase pEvent)
 Constructor. More...
 
FBXSDK_NAMESPACE::FbxAnimCurve * GetFBXCurve ()
 Get the FbxAnimCurve to evaluate, used in story tool for read-only clip. More...
 
- Public Member Functions inherited from FBEvent
 FBEvent (HKEvent pEvent)
 Constructor. More...
 

Public Attributes

FBPropertyDouble KeyIndex
 Read Only Property: Index of the key to evaluate, a decimal value indicates an evaluation between two keys (e.g.: 1.25 -> between key 1 and 2 at 25% of the time between key 1 and 2). More...
 
FBPropertyTime Time
 Read Only Property: Time to evaluate. More...
 
FBPropertyFCurve Curve
 Read Only Property: Curve to evaluate. More...
 
FBPropertyDouble Result
 Read Write Property: Write the resulting value in that prorperty. More...
 
FBPropertyInt LeftCustomTangentTypeIndex
 Read Only Property: FbxAnimCurveOnly - Type of the left key custom tangent type, -1 if not a custom tangent. More...
 
FBPropertyInt RightCustomTangentTypeIndex
 Read Only Property: FbxAnimCurveOnly - Type of the right key custom tangent type, -1 if not a custom tangent. More...
 
- Public Attributes inherited from FBEvent
FBPropertyInt Type
 Read Only Property: Type of event. More...
 

Detailed Description

This class is used when an evaluation must be done on your custom tangents. It contains the necessary information to do the evaluation.

Definition at line 898 of file fbdata.h.

Constructor & Destructor Documentation

◆ FBCurveEvaluationEvent()

FBCurveEvaluationEvent ( HKEventBase  pEvent)

Constructor.

Parameters
pEventBase event (internal) to obtain information from.
Note
Both Time and KeyIndex are valid and can be used to determine where to evaluate.

Member Function Documentation

◆ GetFBXCurve()

FBXSDK_NAMESPACE::FbxAnimCurve* GetFBXCurve ( )

Get the FbxAnimCurve to evaluate, used in story tool for read-only clip.

Returns
Curve to evaluate if successful, NULL otherwise.

Member Data Documentation

◆ Curve

FBPropertyFCurve Curve

Read Only Property: Curve to evaluate.

Definition at line 914 of file fbdata.h.

◆ KeyIndex

FBPropertyDouble KeyIndex

Read Only Property: Index of the key to evaluate, a decimal value indicates an evaluation between two keys (e.g.: 1.25 -> between key 1 and 2 at 25% of the time between key 1 and 2).

Definition at line 912 of file fbdata.h.

◆ LeftCustomTangentTypeIndex

FBPropertyInt LeftCustomTangentTypeIndex

Read Only Property: FbxAnimCurveOnly - Type of the left key custom tangent type, -1 if not a custom tangent.

Definition at line 917 of file fbdata.h.

◆ Result

Read Write Property: Write the resulting value in that prorperty.

Definition at line 915 of file fbdata.h.

◆ RightCustomTangentTypeIndex

FBPropertyInt RightCustomTangentTypeIndex

Read Only Property: FbxAnimCurveOnly - Type of the right key custom tangent type, -1 if not a custom tangent.

Definition at line 918 of file fbdata.h.

◆ Time

Read Only Property: Time to evaluate.

Definition at line 913 of file fbdata.h.


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