FBPropertyAnimatable Class Reference

This reference page is linked to from the following overview topics: FBProperty - Object Properties.

---

Search for all occurrences

---

Detailed Description

Animatable property base class.

Definition at line 1317 of file fbproperties.h.

#include <fbproperties.h>

Inheritance diagram for FBPropertyAnimatable:

List of all members.

Public Member Functions
	FBPropertyAnimatable ()
	Constructor.
virtual	~FBPropertyAnimatable ()
	Destructor.
FBPropertyAnimatable *	InitInternal (KEvaluationProperty *pProperty)
	Initialize internal pointer.
FBPropertyAnimatable *	Init (HFBBox pOwner, char *pName, char *pType, double *pInit)
	Initialization function (custom).
void	Destroy ()
	Destruction function, for internal connectors.
virtual KDataType *	GetDataType () override
	Get the property datatype pointer.
char *	GetDataTypeName ()
	Get the property datatype name.
bool	IsFocused ()
	Is the property focused (keyable).
void	SetFocus (bool pState)
	Set the property's focus (keyable) state.
void	Key ()
	Key the connector.
int	GetDataSize () const
	Get the data size (number of values) for the connector.
virtual bool	IsAnimatable () override
	Certify that the property is animatable.
bool	IsAnimated ()
	Is the property animated.
void	SetAnimated (bool pState)
	Set the animation state of the property.
FBAnimationNode *	GetAnimationNode (FBTake *pTake=NULL)
	Get the animation node for the property.
HFBBox	GetBox ()
	Get the owner box.
virtual void	SetData (void *pData) override
	Set the value of the property, passing the type as an argument.
virtual void	GetData (void *pData, int pSize, HFBEvaluateInfo pEvalInfo=NULL) const override
	Get the value of a property.

---

Constructor & Destructor Documentation

FBPropertyAnimatable

(

)

Constructor.

virtual ~FBPropertyAnimatable

(

)

[virtual]

Destructor.

---

Member Function Documentation

FBPropertyAnimatable* InitInternal

(

KEvaluationProperty *

pProperty

)

Search for all occurrences

Initialize internal pointer.

FBPropertyAnimatable* Init	(	HFBBox	pOwner,
		char *	pName,
		char *	pType,
		double *	pInit
	)

Search for all occurrences

Initialization function (custom).

Parameters:

pOwner	Owner box object.
pName	Name of property to add.
pType	Type name (string) of property.
pInit	Initialization value.

Returns:

this, once initialized.

void Destroy

(

)

Search for all occurrences

Destruction function, for internal connectors.

Used in the case of custom properties in order to remove the connectors.

virtual KDataType* GetDataType

(

)

[override, virtual]

Search for all occurrences

Get the property datatype pointer.

Returns:

Datatype of property.

Reimplemented from FBProperty.

char* GetDataTypeName

(

)

Search for all occurrences

Get the property datatype name.

Returns:

Datatype of property as a character string.

bool IsFocused

(

)

Search for all occurrences

Is the property focused (keyable).

Returns:

Current focus (keyable) state for the property.

void SetFocus

(

bool

pState

)

Search for all occurrences

Set the property's focus (keyable) state.

Parameters:

pState

Focus (keyable) state to set for the property.

void Key

(

)

Search for all occurrences

Key the connector.

int GetDataSize

(

)

const

Search for all occurrences

Get the data size (number of values) for the connector.

Returns:

Data size.

virtual bool IsAnimatable

(

)

[inline, override, virtual]

Search for all occurrences

Certify that the property is animatable.

Returns:

true because it is necessarely an animatable property.

Reimplemented from FBProperty.

Definition at line 1380 of file fbproperties.h.

{ return true; }

bool IsAnimated

(

)

Search for all occurrences

Is the property animated.

This is true if the property has an FCurve associated to it.

Returns:

true if animated, false if not animated.

void SetAnimated

(

bool

pState

)

Search for all occurrences

Set the animation state of the property.

Parameters:

pState

State of animation for property, true to animate, false to remove curves.

FBAnimationNode* GetAnimationNode

(

FBTake *

pTake = NULL

)

Search for all occurrences

Get the animation node for the property.

Parameters:

pTake

to get the animation node from.

Returns:

Animation node for property. NULL is returned if property is not animated.

HFBBox GetBox

(

)

Search for all occurrences

Get the owner box.

Returns:

Handle to the owning box (i.e. model).

virtual void SetData

(

void *

pData

)

[override, virtual]

Search for all occurrences

Set the value of the property, passing the type as an argument.

Parameters:

pData

Value to affect property with.

Reimplemented from FBProperty.

virtual void GetData	(	void *	pData,
		int	pSize,
		HFBEvaluateInfo	pEvalInfo = NULL
	)		const [override, virtual]

Search for all occurrences

Get the value of a property.

Return values:

pValue

Value to fill with property's current value.

---

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

• fbsdk/fbproperties.h