XSI::AnimationSource

AnimationSource Class Reference

Related Scripting Object: AnimationSource

The AnimationSource object represents a special kind of DataSource, for example, ActionSource, Constraint, FCurve, Expression, or StaticSource. More...

#include <xsi_animsource.h>

Inheritance diagram for AnimationSource:

SIObject CBase FCurve List of all members.

Public Member Functions
  AnimationSource ()
  ~AnimationSource ()
  AnimationSource (const CRef &in_ref)
  AnimationSource (const AnimationSource &in_obj)
bool  IsA (siClassID in_ClassID) const
siClassID  GetClassID () const
AnimationSource &  operator= (const AnimationSource &in_obj)
AnimationSource &  operator= (const CRef &in_ref)

Detailed Description

The AnimationSource object represents a special kind of DataSource, for example, ActionSource, Constraint, FCurve, Expression, or StaticSource.

The valid types of AnimationSources are listed in the siAnimationSourceItemType enum documentation.

See also:
AnimationSourceItem, GetSource, ActionSource, Constraint, FCurve, StaticSource, Parameter::GetSource

Constructor & Destructor Documentation

AnimationSource (  ) 

Default constructor.

~AnimationSource (  ) 

Default destructor.

AnimationSource ( const CRef &  in_ref  ) 

Constructor.

Parameters:
in_ref  constant reference object.

AnimationSource ( const AnimationSource &  in_obj  ) 

Copy constructor.

Parameters:
in_obj  constant class object.

Member Function Documentation

bool IsA ( siClassID  in_ClassID  )  const [virtual]

Returns true if a given class type is compatible with this API class.

Parameters:
in_ClassID  class type.
Returns:
true if the class is compatible, false otherwise.

Reimplemented from SIObject.

Reimplemented in FCurve.

siClassID GetClassID (  )  const [virtual]

Returns the type of the API class.

Returns:
The class type.

Reimplemented from SIObject.

Reimplemented in FCurve.

AnimationSource& operator= ( const AnimationSource &  in_obj  ) 

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

Parameters:
in_obj  constant class object.
Returns:
The new AnimationSource object.

AnimationSource& operator= ( const CRef &  in_ref  ) 

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

Parameters:
in_ref  constant class object.
Returns:
The new AnimationSource object.

Reimplemented from SIObject.

Reimplemented in FCurve.

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