fbsdk/fbdata.h File Reference

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>
#include <fbxsdk/fbxsdk_nsbegin.h>
#include <fbxsdk/fbxsdk_nsend.h>

File Description

Animation data types.

This file contains the definitions for various animation data types in the Open Reality SDK.

Definition in file fbdata.h.

Classes

class  FBFCurveKey
 KeyFrame for an FCurve. More...
 
class  FBPropertyListFCurveKey
 List of FCurveKey. More...
 
class  FBFCurve
 FCurve class. More...
 
class  FBFCurveCustomTangent
 This class represents a custom tangents object in the system. More...
 
class  FBPropertyListCustomTangent
 List: Custom Tangent More...
 
class  FBPropertyListAnimationNode
 List of animation nodes. More...
 
class  FBEventAnimationNode
 The transform manipulator has begun doing modifications This event occurs every time a manipulator: More...
 
class  FBCurveEvaluationEvent
 This class is used when an evaluation must be done on your custom tangents. It contains the necessary information to do the evaluation. More...
 
class  FBCurveCustomKeyAddEvent
 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...
 
class  FBCurveCustomKeyChangeEvent
 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...
 
class  FBPropertyEventAnimationNode
 PropertyEvent: UI idle event. More...
 
class  FBPropertyEventAnimationNodeEvaluate
 PropertyEvent: Event when a custom tangent that needs to be evaluated. More...
 
class  FBPropertyEventAnimationNodeKeyAdd
 PropertyEvent: Event when a key that doesn't have a custom tangent is added. More...
 
class  FBPropertyEventAnimationNodeCustomKeyAdd
 PropertyEvent: Event when a key with a custom tangent that needs some of its parameters to be specified is added. More...
 
class  FBPropertyEventAnimationNodeCustomKeyChange
 PropertyEvent: Event when a key tangent is changed to a custom tangent/changed to another type from a custom tangent or the custom tangent index is changed. More...
 
class  FBAnimationNode
 
class  FBAnimationStack
 Used to access animation stack. More...
 
class  FBFCurveCustomTangentManager
 Custom Tangent Manager Interface to the Custom Tangent Manager. More...
 
class  FBPropertyStateEvent
 This class is used when the state of a property tracked by the FBFCurveEventManager is changed. More...
 
class  FBFCurveEvent
 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...
 
class  FBPropertyChanged
 PropertyEvent: Event when a property is modified, to be used with the FBFCurveEventManager. More...
 
class  FBFCurveChanged
 PropertyEvent: Event when a fcurve is changed. More...
 
class  FBFCurveEventManager
 FCurve Event Manager Interface to the FBFCurveEventManager. More...
 
class  FBAnimationLayer
 Used to access animation layer properties and modify them. More...
 
class  FBPropertyListTake
 List: Take More...
 
class  FBTake
 A take is a container for animation in a scene. More...
 
class  FBTimeWarpManager
 Time Warp Manager Interface to the Time Warp Manager. More...
 

Namespaces

 ORSDK2019
 

Macros

#define FBSDK_DLL   K_DLLIMPORT
 Be sure that FBSDK_DLL is defined only once... More...
 
#define ANIMATIONNODE_TYPE_NUMBER   "Number"
 Animation node data types. More...
 
#define ANIMATIONNODE_TYPE_TIME   "Time"
 
#define ANIMATIONNODE_TYPE_TIMECODE   "TimeCode"
 
#define ANIMATIONNODE_TYPE_VECTOR   "Vector"
 
#define ANIMATIONNODE_TYPE_VECTOR_4   "Vector4"
 
#define ANIMATIONNODE_TYPE_OBJECT   "Object"
 
#define ANIMATIONNODE_TYPE_REFERENCE   "Reference"
 
#define ANIMATIONNODE_TYPE_EVENT   "Event"
 
#define ANIMATIONNODE_TYPE_STRING   "String"
 
#define ANIMATIONNODE_TYPE_ACTION   "Action"
 
#define ANIMATIONNODE_TYPE_BOOL   "Bool"
 
#define ANIMATIONNODE_TYPE_ENUM   "Enum"
 
#define ANIMATIONNODE_TYPE_INTEGER   "Integer"
 
#define ANIMATIONNODE_TYPE_OCCLUSION   "Occlusion"
 
#define ANIMATIONNODE_TYPE_FIELDOFVIEWX   "FieldOfViewX"
 
#define ANIMATIONNODE_TYPE_FIELDOFVIEWY   "FieldOfViewY"
 
#define ANIMATIONNODE_TYPE_OPTICALCENTERX   "OpticalCenterX"
 
#define ANIMATIONNODE_TYPE_OPTICALCENTERY   "OpticalCenterY"
 
#define ANIMATIONNODE_TYPE_IKREACHTRANSLATION   "IK Reach Translation"
 
#define ANIMATIONNODE_TYPE_IKREACHROTATION   "IK Reach Rotation"
 
#define ANIMATIONNODE_TYPE_COLOR   "Color"
 
#define ANIMATIONNODE_TYPE_LOCAL_TRANSLATION   "Lcl Translation"
 
#define ANIMATIONNODE_TYPE_LOCAL_ROTATION   "Lcl Rotation"
 
#define ANIMATIONNODE_TYPE_LOCAL_SCALING   "Lcl Scaling"
 
#define ANIMATIONNODE_TYPE_TRANSLATION   "Translation"
 
#define ANIMATIONNODE_TYPE_ROTATION   "Rotation"
 
#define ANIMATIONNODE_TYPE_SCALING   "Scaling"
 
#define ANIMATIONNODE_TYPE_COLOR_RGBA   "ColorAndAlpha"
 

Typedefs

typedef class FBPropertyBaseEnum< enum FBInterpolation > FBPropertyInterpolation
 
typedef class FBPropertyBaseEnum< enum FBTangentMode > FBPropertyTangentMode
 
typedef class FBPropertyBaseEnum< enum FBTangentClampMode > FBPropertyTangentClampMode
 
typedef class FBPropertyBaseEnum< enum FBTangentConstantMode > FBPropertyTangentConstantMode
 
typedef class FBPropertyBaseEnum< enum FBExtrapolationMode > FBPropertyExtrapolationMode
 
typedef class FBPropertyBaseEnum< enum FBAnimationNodeConnectorType > FBPropertyAnimationNodeConnectorType
 
typedef class FBPropertyBaseEnum< enum FBTangentCustomIndex > FBPropertyTangentCustomIndex
 
typedef class FBPropertyBaseEnum< enum FBTangentWeightMode > FBPropertyTangentWeightMode
 
typedef class FBPropertyBase< FBFCurve *, kFBPT_object > FBPropertyBaseFCurve
 
typedef class FBPropertyBaseComponent< FBFCurve * > FBPropertyFCurve
 
typedef class FBPropertyBase< FBFBFCurveCustomTangent *, kFBPT_object > FBPropertyBaseFBFCurveCustomTangent
 
typedef class FBPropertyBaseComponent< FBFBFCurveCustomTangent * > FBPropertyFBFCurveCustomTangent
 
typedef class FBPropertyBaseList< FBAnimationNode * > FBPropertyBaseListAnimationNode
 
typedef class FBPropertyBaseEnum< enum FBEventAnimationNodeType > FBPropertyEventAnimationNodeType
 
typedef class FBPropertyBaseEnum< enum FBCustomKeyChangeType > FBPropertyCustomKeyChangeType
 
typedef bool(* kFBDataHandler) (void *pBuffer, FBEvaluateInfo *pEvaluateInfo, FBAnimationNode *pAnimationNode, void *p1, void *p2)
 kFBDataHandler More...
 
typedef class FBPropertyBase< FBAnimationNode *, kFBPT_object > FBPropertyBaseAnimationNode
 
typedef class FBPropertyBaseComponent< FBAnimationNode * > FBPropertyAnimationNode
 
typedef class FBPropertyBaseEnum< enum FBPropertyStateEventType > FBPropertyPropertyStateEventType
 
typedef class FBPropertyBaseEnum< enum FBFCurveEventType > FBPropertyFCurveEventType
 
typedef class FBPropertyBaseEnum< enum FBLayerMode > FBPropertyLayerMode
 
typedef class FBPropertyBaseEnum< enum FBLayerRotationMode > FBPropertyLayerRotationMode
 
typedef class FBPropertyBase< FBTake *, kFBPT_object > FBPropertyBaseTake
 
typedef class FBPropertyBaseComponent< FBTake * > FBPropertyTake
 

Enumerations

enum  FBInterpolation {
  kFBInterpolationInvalid = -1, kFBInterpolationConstant = 0, kFBInterpolationLinear, kFBInterpolationCubic,
  kFBInterpolationCustom, kFBInterpolationCount
}
 Types of interpolation for an FCurve. More...
 
enum  FBInterpolatorCurveType {
  kFBInterpolatorCurveLinearIn, kFBInterpolatorCurveLinearOut, kFBInterpolatorCurveSmoothIn, kFBInterpolatorCurveSmoothOut,
  kFBInterpolatorCurveSlowIn, kFBInterpolatorCurveSlowOut, kFBInterpolatorCurveFastIn, kFBInterpolatorCurveFastOut,
  kFBInterpolatorCurveLast
}
 Types of interpolator for an FCurve. More...
 
enum  FBTangentMode {
  kFBTangentModeAuto, kFBTangentModeTCB, kFBTangentModeUser, kFBTangentModeBreak,
  kFBTangentModeTimeIndependent, kFBTangentModeClampProgressive
}
 Methods of tangent calculation. More...
 
enum  FBTangentClampMode { kFBTangentClampModeNone, kFBTangentClampModeClamped }
 Different clamping modes for the tangents. More...
 
enum  FBTangentConstantMode { kFBTangentConstantModeNormal, kFBTangentConstantModeNext }
 Different constant modes for the tangents. More...
 
enum  FBExtrapolationMode {
  kFCurveExtrapolationConst = 1, kFCurveExtrapolationRepetition = 2, kFCurveExtrapolationMirrorRepetition = 3, kFCurveExtrapolationKeepSlope = 4,
  kFCurveExtrapolationRelativeRepetition = 5
}
 Modes for pre / post extrapolation. More...
 
enum  FBAnimationNodeConnectorType { kFBAnimationNodeConnectorTypeNone, kFBAnimationNodeConnectorTypeConnectedIn, kFBAnimationNodeConnectorTypeConnectedOut, kFBAnimationNodeConnectorTypeConstantIn }
 Different types for the animation node connectors. More...
 
enum  FBTangentCustomIndex { kFBTangentCustomIndex0, kFBTangentCustomIndex1, kFBTangentCustomIndex2 }
 Custom tangent index for the tangents. More...
 
enum  FBTangentWeightMode { kFBTangentWeightModeNone, kFBTangentWeightModeRight, kFBTangentWeightModeNextLeft, kFBTangentWeightModeBoth }
 Active tangent weight, no/one/both side are active on a key. More...
 
enum  FBEventAnimationNodeType { kFBEventAnimationNodeDataChange, kFBEventAnimationNodeConstraintChange, kFBEventAnimationNodeNone }
 Event based on animation node. More...
 
enum  FBCustomKeyChangeType { kFBNoChange, kFBInterpolationChange, kFBCustomTangentChange }
 Indicate if the interpolation or the custom index of the key will be/was modified. More...
 
enum  FBPropertyStateEventType {
  kFBPropertyStateEventTypeUnknownOperation = 0, kFBPropertyStateEventTypeAttached = 1 << 0, kFBPropertyStateEventTypeDetached = 1 << 1, kFBPropertyStateEventTypeDestroyed = 1 << 2,
  kFBPropertyStateEventTypeMassOperation = 1 << 3
}
 This enum indicates what modification was made to the animation of a tracked property. More...
 
enum  FBFCurveEventType {
  kFBFCurveEventTypeUnknownOperation = 0, kFBFCurveEventTypeKeyAdded = 1 << 0, kFBFCurveEventTypeKeyRemoved = 1 << 1, kFBFCurveEventTypeKeyTimeChanged = 1 << 2,
  kFBFCurveEventTypeKeyValueChanged = 1 << 3, kFBFCurveEventTypeDerivativedChanged = 1 << 4, kFBFCurveEventTypeKeyInterpolationChanged = 1 << 5, kFBFCurveEventTypeKeyTangentChanged = 1 << 6,
  kFBFCurveEventTypeKeyTangentBreakChanged = 1 << 7, kFBFCurveEventTypeKeyTangentClampModeChanged = 1 << 8, kFBFCurveEventTypeKeyTangentConstantChanged = 1 << 9, kFBFCurveEventTypeKeyVelocityChanged = 1 << 10,
  kFBFCurveEventTypeKeyWeightChanged = 1 << 11, kFBFCurveEventTypeKeyTensionChanged = 1 << 12, kFBFCurveEventTypeKeyContinuityChanged = 1 << 13, kFBFCurveEventTypeKeyBiasChanged = 1 << 14,
  kFBFCurveEventTypeKeyPreExtrapolationChanged = 1 << 15, kFBFCurveEventTypeKeyPostExtrapolationChanged = 1 << 16, kFBFCurveEventTypeKeyMassOperation = 1 << 17
}
 This enum indicates what modification was made to a tracked FCurve. More...
 
enum  FBLayerMode { kFBLayerModeInvalidIndex = -1, kFBLayerModeAdditive = 0, kFBLayerModeOverride, kFBLayerModeOverridePassthrough }
 Layer mode. More...
 
enum  FBLayerRotationMode { kFBLayerRotationModeInvalidIndex = -1, kFBLayerRotationModeEulerRotation = 0, kFBLayerRotationModeQuaternionRotation }
 Rotation mode for layer. More...
 
enum  FBAnimationLayerMergeOptions {
  kFBAnimLayerMerge_SelectedLayers_SelectedProperties, kFBAnimLayerMerge_AllLayers_SelectedProperties, kFBAnimLayerMerge_SelectedLayers_AllProperties, kFBAnimLayerMerge_AllLayers_AllProperties,
  kFBAnimLayerMerge_SelectedLayers_CompleteScene, kFBAnimLayerMerge_AllLayers_CompleteScene
}
 Merge option for animation layers. More...
 
enum  FBMergeLayerMode { kFBMergeLayerModeAutomatic, kFBMergeLayerModeAdditive, kFBMergeLayerModeOverride }
 Merge layer mode for animation layers. This will specify the mode of the resulting merged layer, if applicable (To BaseAnimation layer mode cannot be modified). More...
 
enum  FBTimeMarkAction { kFBTimeMarkAction_None, kFBTimeMarkAction_Stop, kFBTimeMarkAction_Loop }
 Time (Global & Take) Mark assigned action. More...
 
enum  FBPropertyComponents {
  kFBPropertyComponent0 = 1 << 0, kFBPropertyComponent1 = 1 << 1, kFBPropertyComponent2 = 1 << 2, kFBPropertyComponent3 = 1 << 3,
  kFBPropertyComponentAll
}
 Property Components Bit Field (XYZ, RGB, RGBA, UV, XYZW, etc.). More...
 

Functions

FBXSDK_NAMESPACE::FbxProperty FBtoFBXProperty (FBProperty *pSourceProperty, FBTake *pSourceTake, FBXSDK_NAMESPACE::FbxObject *pDestinationObject, FBXSDK_NAMESPACE::FbxScene *pDestinationScene, FBXSDK_NAMESPACE::FbxAnimStack *pDestinationStack, bool pCopyAnimation=true)
 Convert a FBProperty to a FbxProperty, useful to extract some properties to a FBX file. More...
 
FBProperty * FBXtoFBProperty (FBXSDK_NAMESPACE::FbxProperty *pSourceProperty, FBXSDK_NAMESPACE::FbxAnimStack *pSourceStack, FBComponent *pDestinationObject, FBTake *pDestinationTake, bool pCopyAnimation=true, FBTime pLimitStart=FBTime::MinusInfinity, FBTime pLimitEnd=FBTime::Infinity)
 Convert a FbxProperty to a FBProperty, useful to extract some properties from a FBX file to a MotionBuilder scene. More...
 

Macro Definition Documentation

#define ANIMATIONNODE_TYPE_ACTION   "Action"
#define ANIMATIONNODE_TYPE_BOOL   "Bool"
#define ANIMATIONNODE_TYPE_COLOR   "Color"
#define ANIMATIONNODE_TYPE_COLOR_RGBA   "ColorAndAlpha"
+ Examples:

Definition at line 99 of file fbdata.h.

#define ANIMATIONNODE_TYPE_ENUM   "Enum"

Definition at line 79 of file fbdata.h.

#define ANIMATIONNODE_TYPE_EVENT   "Event"

Definition at line 73 of file fbdata.h.

#define ANIMATIONNODE_TYPE_FIELDOFVIEWX   "FieldOfViewX"

Definition at line 82 of file fbdata.h.

#define ANIMATIONNODE_TYPE_FIELDOFVIEWY   "FieldOfViewY"

Definition at line 83 of file fbdata.h.

#define ANIMATIONNODE_TYPE_IKREACHROTATION   "IK Reach Rotation"

Definition at line 87 of file fbdata.h.

#define ANIMATIONNODE_TYPE_IKREACHTRANSLATION   "IK Reach Translation"

Definition at line 86 of file fbdata.h.

#define ANIMATIONNODE_TYPE_INTEGER   "Integer"
#define ANIMATIONNODE_TYPE_LOCAL_SCALING   "Lcl Scaling"
#define ANIMATIONNODE_TYPE_OBJECT   "Object"

Definition at line 71 of file fbdata.h.

#define ANIMATIONNODE_TYPE_OCCLUSION   "Occlusion"
+ Examples:

Definition at line 81 of file fbdata.h.

#define ANIMATIONNODE_TYPE_OPTICALCENTERX   "OpticalCenterX"

Definition at line 84 of file fbdata.h.

#define ANIMATIONNODE_TYPE_OPTICALCENTERY   "OpticalCenterY"

Definition at line 85 of file fbdata.h.

#define ANIMATIONNODE_TYPE_REFERENCE   "Reference"

Definition at line 72 of file fbdata.h.

#define ANIMATIONNODE_TYPE_STRING   "String"

Definition at line 74 of file fbdata.h.

#define ANIMATIONNODE_TYPE_TIME   "Time"

Definition at line 67 of file fbdata.h.

#define ANIMATIONNODE_TYPE_TIMECODE   "TimeCode"
#define ANIMATIONNODE_TYPE_VECTOR_4   "Vector4"

Definition at line 70 of file fbdata.h.

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 50 of file fbdata.h.

Go to the source code of this file.