Open Reality Reference Guide
FBFCurveEvent Class Reference

This class is used when a modification is made on a FCurve. It contains the necessary information to identify the owner of the curve and what modification was made. More...

#include <fbdata.h>

Inheritance diagram for FBFCurveEvent:

Public Member Functions

 FBFCurveEvent (HKEventBase pEvent)
 Constructor. More...
 
FBPropertyGetParentProperty ()
 Return the parent FBProperty of the curve if possible. 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

FBPropertyFCurveEventType EventType
 Read Only Property: Type of fcurve event. More...
 
FBPropertyInt KeyIndexStart
 Read Only Property: Index of the first key which is involved in the event. More...
 
FBPropertyInt KeyIndexStop
 Read Only Property: Index of the last key which is involved in the event. More...
 
FBPropertyFCurve Curve
 Read Only Property: Curve that will receive the new key. More...
 
FBPropertyString CurveName
 Read Only Property: Name of curve. More...
 
FBPropertyInt CurveIndex
 Read Only Property: Index of curve. More...
 
- Public Attributes inherited from FBEvent
FBPropertyInt Type
 Read Only Property: Type of event. More...
 

Detailed Description

This class is used when a modification is made on a FCurve. It contains the necessary information to identify the owner of the curve and what modification was made.

Definition at line 1403 of file fbdata.h.

Constructor & Destructor Documentation

◆ FBFCurveEvent()

FBFCurveEvent ( 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.

◆ GetParentProperty()

FBProperty* GetParentProperty ( )

Return the parent FBProperty of the curve if possible.

Returns
FBProperty 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 1429 of file fbdata.h.

◆ CurveIndex

FBPropertyInt CurveIndex

Read Only Property: Index of curve.

Definition at line 1431 of file fbdata.h.

◆ CurveName

FBPropertyString CurveName

Read Only Property: Name of curve.

Definition at line 1430 of file fbdata.h.

◆ EventType

FBPropertyFCurveEventType EventType

Read Only Property: Type of fcurve event.

Definition at line 1426 of file fbdata.h.

◆ KeyIndexStart

FBPropertyInt KeyIndexStart

Read Only Property: Index of the first key which is involved in the event.

Definition at line 1427 of file fbdata.h.

◆ KeyIndexStop

FBPropertyInt KeyIndexStop

Read Only Property: Index of the last key which is involved in the event.

Definition at line 1428 of file fbdata.h.


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