All Frameworks Class Hierarchy This Framework Indexes Previous Next

SIMAnimationStandardItf Interface CATIAnimationValues

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIAnimationValues

Role: Interface dedicated for the accessing the information of an animation object.

This interface provides authoring capability for an animation object. The end-user must make sure the proper setup (licensing) is available for data creation.

Method Index

o AddValues(PropertyType,CATBaseUnknown*,CATListValCATBaseUnknown_var&): Adds a list a values to the current animation object.
o BeginValueInsertion(): Initializes the value insertion.
o EndValueInsertion(): Ends the value insertion.
o GetValues(PropertyType,CATBaseUnknown*,CATListValCATBaseUnknown_var&): Retrieves a list a values from the current animation object.
o SetInterval(double): Sets the playback interval for the animation.

Methods

o AddValues

public virtual AddValues(		`iPropertyType`,
		`ipBUAnimatedObject`,
	const	`iValue`)

Adds a list a values to the current animation object.
Role: This method adds a list of values based on:

property type identifier
animated object

Parameters:

PropertyType: iPropertyType [in] The property type identifier.
ipBUAnimatedObject: [in] The animated object.
iValue: [in] The list of values.

o BeginValueInsertion

public virtual BeginValueInsertion(

)

Initializes the value insertion.
Role: This method initializes the value insertion. It must be called before any value is added.

o EndValueInsertion

public virtual EndValueInsertion(

)

Ends the value insertion.
Role: This method ends the value insertion. It must be called after all values are added so that they can be persisted.

o GetValues

public virtual GetValues(		`iPropertyType`,
		`ipBUAnimatedObject`,
		`oValue`)

Retrieves a list a values from the current animation object.
Role: This method retrieves a list of values based on:

property type identifier
animated object

Parameters:

PropertyType: iPropertyType [in] The property type identifier.
ipBUAnimatedObject: [in] The animated object.
oValue: [out] The list of values to be retrieved.

o SetInterval

public virtual SetInterval( iInterval)

Sets the playback interval for the animation.
Role: This methods sets the interval for the animation.

Parameters:

iInterval: [in] The interval to set. Should be greater than zero.

This object is included in the file: CATIAnimationValues.h
If needed, your Imakefile.mk should include the module: SIMAnimationStandardItf