Open Reality Reference Guide
FBCurveCustomKeyAddEvent Class Reference

This class is used when adding a key with a custom tangent to a curve. It contains the necessary information for the user to specify the properties of the key. More...

#include <fbdata.h>

Inheritance diagram for FBCurveCustomKeyAddEvent:

Public Member Functions

 FBCurveCustomKeyAddEvent (HKEventBase pEvent)
 Constructor. More...
 
FBAnimationNodeGetParentAnimationNode ()
 Return the parent FBAnimationNode of the curve if possible. More...
 
FBComponentGetParentComponent ()
 Return the parent object holding the FBAnimationNode of the curve if possible. More...
 
- Public Member Functions inherited from FBEvent
 FBEvent (HKEvent pEvent)
 Constructor. More...
 

Public Attributes

FBPropertyInt KeyIndex
 Read Only Property: Index of the new key that will be added More...
 
FBPropertyTime Time
 Read Only Property: Time where the key will be added. More...
 
FBPropertyFCurve Curve
 Read Only Property: Curve that will receive the new key. More...
 
- Public Attributes inherited from FBEvent
FBPropertyInt Type
 Read Only Property: Type of event. More...
 

Detailed Description

This class is used when adding a key with a custom tangent to a curve. It contains the necessary information for the user to specify the properties of the key.

Definition at line 927 of file fbdata.h.

Constructor & Destructor Documentation

◆ FBCurveCustomKeyAddEvent()

FBCurveCustomKeyAddEvent ( HKEventBase  pEvent)

Constructor.

Parameters
pEventBase event (internal) to obtain information from.

Member Function Documentation

◆ GetParentAnimationNode()

FBAnimationNode* GetParentAnimationNode ( )

Return the parent FBAnimationNode of the curve if possible.

Returns
FBAnimationNode of the curve if possible, NULL otherwise.

◆ GetParentComponent()

FBComponent* GetParentComponent ( )

Return the parent object holding the FBAnimationNode of the curve if possible.

Returns
Parent (FBComponent) of the curve if possible, NULL otherwise.

Member Data Documentation

◆ Curve

FBPropertyFCurve Curve

Read Only Property: Curve that will receive the new key.

Definition at line 947 of file fbdata.h.

◆ KeyIndex

FBPropertyInt KeyIndex

Read Only Property: Index of the new key that will be added

Definition at line 945 of file fbdata.h.

◆ Time

Read Only Property: Time where the key will be added.

Definition at line 946 of file fbdata.h.


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