Open Reality Reference Guide
FBCurveCustomKeyChangeEvent Class Reference

This class is used when changing the interpolation type/custom tangent index of a key with a custom tangent. It contains the necessary information for the user to identify the key. More...

#include <fbdata.h>

Inheritance diagram for FBCurveCustomKeyChangeEvent:

Public Member Functions

 FBCurveCustomKeyChangeEvent (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

FBPropertyBool IsPreCall
 Read Only Property: True before the value is actually changed (allowing you to cache the current state if needed), false otherwise. More...
 
FBPropertyCustomKeyChangeType ChangeType
 Read Write Property: Indicate which setting of the key was/will be changed. More...
 
FBPropertyInt KeyIndex
 Read Only Property: Index of the key with the custom tangent type. More...
 
FBPropertyTime Time
 Read Only Property: Time of the key. More...
 
FBPropertyFCurve Curve
 Read Only Property: Curve with the key set to the custom tangent type.
More...
 
- Public Attributes inherited from FBEvent
FBPropertyInt Type
 Read Only Property: Type of event. More...
 

Detailed Description

This class is used when changing the interpolation type/custom tangent index of a key with a custom tangent. It contains the necessary information for the user to identify the key.

Definition at line 965 of file fbdata.h.

Constructor & Destructor Documentation

◆ FBCurveCustomKeyChangeEvent()

FBCurveCustomKeyChangeEvent ( 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

◆ ChangeType

FBPropertyCustomKeyChangeType ChangeType

Read Write Property: Indicate which setting of the key was/will be changed.

Definition at line 984 of file fbdata.h.

◆ Curve

FBPropertyFCurve Curve

Read Only Property: Curve with the key set to the custom tangent type.

Definition at line 988 of file fbdata.h.

◆ IsPreCall

FBPropertyBool IsPreCall

Read Only Property: True before the value is actually changed (allowing you to cache the current state if needed), false otherwise.

Definition at line 983 of file fbdata.h.

◆ KeyIndex

FBPropertyInt KeyIndex

Read Only Property: Index of the key with the custom tangent type.

Definition at line 986 of file fbdata.h.

◆ Time

Read Only Property: Time of the key.

Definition at line 987 of file fbdata.h.


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