fbdata.h File Reference

---

Detailed Description

fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h fbdata.h

Animation data types.

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

Definition in file fbdata.h.

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>

Include dependency graph for fbdata.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	FBFCurveKey
	KeyFrame for an FCurve. More...
class	FBPropertyListFCurveKey
	List of FCurveKey. More...
class	FBFCurve
	FCurve class. More...
class	FBPropertyListAnimationNode
	List of animation nodes. More...
class	FBEventAnimationNode
	The transform manipulator has begun doing modifications This event occurs every time a manipulator: receives mouse input begins/ends a transaction manipulates/moves and object. More...
class	FBPropertyEventAnimationNode
	PropertyEvent: UI idle event. More...
class	FBAnimationNode
class	FBAnimationLayer
	Animation Layer class. More...
class	FBPropertyListTake
	List: Take More...
class	FBTake
	A take is a container for animation in a scene. More...
Defines
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once.
#define	ANIMATIONNODE_TYPE_NUMBER   "Number"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_TIME   "Time"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_VECTOR   "Vector"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_VECTOR_4   "Vector4"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_OBJECT   "Object"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_REFERENCE   "Reference"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_EVENT   "Event"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_STRING   "String"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_ACTION   "Action"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_BOOL   "Bool"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_ENUM   "Enum"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_INTEGER   "Integer"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_OCCLUSION   "Occlusion"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_FIELDOFVIEWX   "FieldOfViewX"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_FIELDOFVIEWY   "FieldOfViewY"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_OPTICALCENTERX   "OpticalCenterX"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_OPTICALCENTERY   "OpticalCenterY"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_IKREACHTRANSLATION   "IKReachTranslation"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_IKREACHROTATION   "IKReachRotation"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_COLOR   "Color"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_LOCAL_TRANSLATION   "Lcl Translation"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_LOCAL_ROTATION   "Lcl Rotation"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_LOCAL_SCALING   "Lcl Scaling"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_TRANSLATION   "Translation"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_ROTATION   "Rotation"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_SCALING   "Scaling"
	Animation node data types.
#define	ANIMATIONNODE_TYPE_COLOR_RGBA   "ColorAndAlpha"
	Animation node data types.
Typedefs
typedef bool(*	kFBDataHandler )(void *pBuffer, HFBEvaluateInfo pEvaluateInfo, HFBAnimationNode pAnimationNode, void *p1, void *p2)
	kFBDataHandler
Enumerations
enum	FBInterpolation {    kFBInterpolationInvalid = -1,    kFBInterpolationConstant = 0,    kFBInterpolationLinear,    kFBInterpolationCubic,    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 }
	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	FBEventAnimationNodeType {    kFBEventAnimationNodeDataChange,    kFBEventAnimationNodeConstraintChange,    kFBEventAnimationNodeNone }
	Event based on animation node. More...
enum	FBLayerMode {    kFBLayerModeInvalidIndex = -1,    kFBLayerModeAdditive = 0,    kFBLayerModeOverride,    kFBLayerModeOverridePassthrough }
	Layer mode. More...
enum	FBLayerRotationMode {    kFBLayerRotationModeInvalidIndex = -1,    kFBLayerRotationModeEulerRotation = 0,    kFBLayerRotationModeQuaternionRotation }
	Rotation mode for layer. More...
Functions
	FB_DEFINE_COMPONENT (K_DLLIMPORT, AnimationNode)
	Animation node class.

---

Define Documentation

#define ANIMATIONNODE_TYPE_ACTION   "Action"

Animation node data types.

Definition at line 68 of file fbdata.h.

#define ANIMATIONNODE_TYPE_BOOL   "Bool"

Animation node data types.

Definition at line 69 of file fbdata.h.

#define ANIMATIONNODE_TYPE_COLOR   "Color"

Animation node data types.

Definition at line 81 of file fbdata.h.

#define ANIMATIONNODE_TYPE_COLOR_RGBA   "ColorAndAlpha"

Animation node data types.

Definition at line 90 of file fbdata.h.

#define ANIMATIONNODE_TYPE_ENUM   "Enum"

Animation node data types.

Definition at line 70 of file fbdata.h.

#define ANIMATIONNODE_TYPE_EVENT   "Event"

Animation node data types.

Definition at line 64 of file fbdata.h.

#define ANIMATIONNODE_TYPE_FIELDOFVIEWX   "FieldOfViewX"

Animation node data types.

Definition at line 73 of file fbdata.h.

#define ANIMATIONNODE_TYPE_FIELDOFVIEWY   "FieldOfViewY"

Animation node data types.

Definition at line 74 of file fbdata.h.

#define ANIMATIONNODE_TYPE_IKREACHROTATION   "IKReachRotation"

Animation node data types.

Definition at line 78 of file fbdata.h.

#define ANIMATIONNODE_TYPE_IKREACHTRANSLATION   "IKReachTranslation"

Animation node data types.

Definition at line 77 of file fbdata.h.

#define ANIMATIONNODE_TYPE_INTEGER   "Integer"

Animation node data types.

Definition at line 71 of file fbdata.h.

#define ANIMATIONNODE_TYPE_LOCAL_ROTATION   "Lcl Rotation"

Animation node data types.

Definition at line 83 of file fbdata.h.

#define ANIMATIONNODE_TYPE_LOCAL_SCALING   "Lcl Scaling"

Animation node data types.

Definition at line 84 of file fbdata.h.

#define ANIMATIONNODE_TYPE_LOCAL_TRANSLATION   "Lcl Translation"

Animation node data types.

Definition at line 82 of file fbdata.h.

#define ANIMATIONNODE_TYPE_NUMBER   "Number"

Animation node data types.

Definition at line 58 of file fbdata.h.

#define ANIMATIONNODE_TYPE_OBJECT   "Object"

Animation node data types.

Definition at line 62 of file fbdata.h.

#define ANIMATIONNODE_TYPE_OCCLUSION   "Occlusion"

Animation node data types.

Definition at line 72 of file fbdata.h.

#define ANIMATIONNODE_TYPE_OPTICALCENTERX   "OpticalCenterX"

Animation node data types.

Definition at line 75 of file fbdata.h.

#define ANIMATIONNODE_TYPE_OPTICALCENTERY   "OpticalCenterY"

Animation node data types.

Definition at line 76 of file fbdata.h.

#define ANIMATIONNODE_TYPE_REFERENCE   "Reference"

Animation node data types.

Definition at line 63 of file fbdata.h.

#define ANIMATIONNODE_TYPE_ROTATION   "Rotation"

Animation node data types.

Definition at line 86 of file fbdata.h.

#define ANIMATIONNODE_TYPE_SCALING   "Scaling"

Animation node data types.

Definition at line 87 of file fbdata.h.

#define ANIMATIONNODE_TYPE_STRING   "String"

Animation node data types.

Definition at line 65 of file fbdata.h.

#define ANIMATIONNODE_TYPE_TIME   "Time"

Animation node data types.

Definition at line 59 of file fbdata.h.

#define ANIMATIONNODE_TYPE_TRANSLATION   "Translation"

Animation node data types.

Definition at line 85 of file fbdata.h.

#define ANIMATIONNODE_TYPE_VECTOR   "Vector"

Animation node data types.

Definition at line 60 of file fbdata.h.

#define ANIMATIONNODE_TYPE_VECTOR_4   "Vector4"

Animation node data types.

Definition at line 61 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.

---

Typedef Documentation

typedef bool(* kFBDataHandler)(void *pBuffer, HFBEvaluateInfo pEvaluateInfo, HFBAnimationNode pAnimationNode, void *p1, void *p2)

kFBDataHandler

Parameters:

	pBuffer
	pEvaluateInfo
	pAnimationNode
	p1
	p2

Definition at line 473 of file fbdata.h.

---

Enumeration Type Documentation

enum FBEventAnimationNodeType

Event based on animation node.

Types of transformation.

Enumerator:

kFBEventAnimationNodeDataChange
kFBEventAnimationNodeConstraintChange
kFBEventAnimationNodeNone

Definition at line 425 of file fbdata.h.

enum FBInterpolation

Types of interpolation for an FCurve.

Enumerator:

kFBInterpolationInvalid	Invalid interpolation.
kFBInterpolationConstant	Constant interpolation.
kFBInterpolationLinear	Linear interpolation.
kFBInterpolationCubic	Cubic interpolation.
kFBInterpolationCount	Number of interpolation types.

Definition at line 104 of file fbdata.h.

enum FBInterpolatorCurveType

Types of interpolator for an FCurve.

Enumerator:

kFBInterpolatorCurveLinearIn
kFBInterpolatorCurveLinearOut
kFBInterpolatorCurveSmoothIn
kFBInterpolatorCurveSmoothOut
kFBInterpolatorCurveSlowIn
kFBInterpolatorCurveSlowOut
kFBInterpolatorCurveFastIn
kFBInterpolatorCurveFastOut
kFBInterpolatorCurveLast

Definition at line 114 of file fbdata.h.

enum FBLayerMode

Layer mode.

Enumerator:

kFBLayerModeInvalidIndex	Invalid value.
kFBLayerModeAdditive	Layer value will be added to the other layers to computed the final value.
kFBLayerModeOverride	Layer value will override the value of the other precedent layers.
kFBLayerModeOverridePassthrough	If the layer has a weigth of 75%, the precedent layers will have a combined effect of 25% on the final value. Setting the weigth to 100% is similar to setting the layer in override.

Definition at line 609 of file fbdata.h.

enum FBLayerRotationMode

Rotation mode for layer.

Enumerator:

kFBLayerRotationModeInvalidIndex	Invalid value.
kFBLayerRotationModeEulerRotation	The rotation will be computed component by component.
kFBLayerRotationModeQuaternionRotation	The rotation will be computed using quaternion.

Definition at line 620 of file fbdata.h.

enum FBTangentClampMode

Different clamping modes for the tangents.

Enumerator:

kFBTangentClampModeNone	The tangent will act normally.
kFBTangentClampModeClamped	The tangent will be flattened when the key is placed at the same value as an adjacent key.

Definition at line 140 of file fbdata.h.

enum FBTangentConstantMode

Different constant modes for the tangents.

Enumerator:

kFBTangentConstantModeNormal	The tangent will contain the value of the current keyframe until the next keyframe.
kFBTangentConstantModeNext	The tangent will contain the value of the next keyframe.

Definition at line 150 of file fbdata.h.

enum FBTangentMode

Methods of tangent calculation.

This is only relevant when interpolation is CUBIC.

Enumerator:

kFBTangentModeAuto	This is the equivalent to a cardinal spline with no parametrization.
kFBTangentModeTCB	TCB spline (3 parameters: TENSION, CONTINUITY, BIAS).
kFBTangentModeUser	Used to represent all splines with no lost data (HERMITE, BEZIER, CATMUL, etc.).
kFBTangentModeBreak	Like USER but left slope may differ from right.

Definition at line 129 of file fbdata.h.

---

Function Documentation

FB_DEFINE_COMPONENT	(	K_DLLIMPORT	,
		AnimationNode
	)

Animation node class.

---

Please send us your comments about this page.